Package org.springdoc.core.versions

Class QueryParamVersionStrategy

java.lang.Object

org.springdoc.core.versions.SpringDocVersionStrategy

org.springdoc.core.versions.QueryParamVersionStrategy

public class QueryParamVersionStrategy
extends SpringDocVersionStrategy

The type Query param version strategy.

Author:

bnasslahsen

Field Summary

Fields inherited from class org.springdoc.core.versions.SpringDocVersionStrategy

defaultVersion, version, versionDefaultMap

Constructor Summary

Constructors

Constructor	Description
QueryParamVersionStrategy(String parameterName, String defaultVersion)	Instantiates a new Query param version strategy.

Method Summary

Modifier and Type	Method	Description
String	getParameterName()	Gets parameter name.
Map<String,String>	updateQueryParams(Map<String,String> queryParams)	Update query params map.
void	updateVersion(String version, String[] params)	Update version.

Methods inherited from class org.springdoc.core.versions.SpringDocVersionStrategy

getVersion, getVersionDefaultMap, setVersion, updateOperationPath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QueryParamVersionStrategy

public QueryParamVersionStrategy(String parameterName,
 String defaultVersion)

Instantiates a new Query param version strategy.

Parameters:

parameterName - the parameter name

Method Details

getParameterName

public String getParameterName()

Gets parameter name.

Returns:

the parameter name

updateVersion

public void updateVersion(String version,
 String[] params)

Description copied from class: SpringDocVersionStrategy

Update version.

Overrides:

updateVersion in class SpringDocVersionStrategy

Parameters:

version - the version

params - the params

updateQueryParams

public Map<String,String> updateQueryParams(Map<String,String> queryParams)

Description copied from class: SpringDocVersionStrategy

Update query params map.

Overrides:

updateQueryParams in class SpringDocVersionStrategy

Parameters:

queryParams - the query params

Returns:

the map