Package org.springdoc.core.versions

Class SpringDocVersionStrategy

java.lang.Object

org.springdoc.core.versions.SpringDocVersionStrategy

Direct Known Subclasses:

HeaderVersionStrategy, MediaTypeVersionStrategy, PathVersionStrategy, QueryParamVersionStrategy

public abstract class SpringDocVersionStrategy
extends Object

The interface Spring doc version strategy.

Author:

bnasslahsen

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	defaultVersion	The Default version.
protected String	version	The Version.
protected Map<String,String>	versionDefaultMap	The Default values.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SpringDocVersionStrategy(String defaultVersion)	Instantiates a new Spring doc version strategy.

Method Summary

Modifier and Type	Method	Description
String	getVersion()	Gets version.
Map<String,String>	getVersionDefaultMap()
void	setVersion(String version)	Sets version.
String	updateOperationPath(String operationPath, String version)	Gets operation path.
Map<String,String>	updateQueryParams(Map<String,String> queryParams)	Update query params map.
void	updateVersion(String version, String[] params)	Update version.

Methods inherited from class java.lang.Object

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

Field Details

version

protected String version

The Version.

defaultVersion

protected final String defaultVersion

The Default version.

versionDefaultMap

protected Map<String,String> versionDefaultMap

The Default values.

Constructor Details

SpringDocVersionStrategy

protected SpringDocVersionStrategy(String defaultVersion)

Instantiates a new Spring doc version strategy.

Parameters:

defaultVersion - the default version

Method Details

getVersion

public String getVersion()

Gets version.

Returns:

the version

setVersion

public void setVersion(String version)

Sets version.

Parameters:

version - the version

updateVersion

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

Update version.

Parameters:

version - the version

params - the params

updateQueryParams

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

Update query params map.

Parameters:

queryParams - the query params

Returns:

the map

updateOperationPath

public String updateOperationPath(String operationPath,
 String version)

Gets operation path.

Parameters:

operationPath - the operation path

version - the version

Returns:

the operation path

getVersionDefaultMap

public Map<String,String> getVersionDefaultMap()