springfox.documentation.spi.schema

Interface UniqueTypeNameAdapter

public interface UniqueTypeNameAdapter

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getNames() Provides information about model names
java.util.Optional<java.lang.String>	getTypeName(java.lang.String typeId) Returns type for the model
void	registerType(java.lang.String typeName, java.lang.String typeId) Add model name as is without adjusting
void	registerUniqueType(java.lang.String typeName, java.lang.String typeId) Register model name to keep it unique
void	setEqualityFor(java.lang.String typeIdOf, java.lang.String typeIdTo) Sets equality of two models to make sure, that models will be treated as one

Method Detail

getNames

java.util.Map<java.lang.String,java.lang.String> getNames()

Provides information about model names

Returns:

a map with Models id and name

getTypeName

java.util.Optional<java.lang.String> getTypeName(java.lang.String typeId)

Returns type for the model

Parameters:

typeId - - id of model type

Returns:

Optional of a model names

registerType

void registerType(java.lang.String typeName,
                  java.lang.String typeId)

Add model name as is without adjusting

Parameters:

typeName - - string representation of the models name

typeId - - id of model type

registerUniqueType

void registerUniqueType(java.lang.String typeName,
                        java.lang.String typeId)

Register model name to keep it unique

Parameters:

typeName - - string representation of the models name

typeId - - id of model type

setEqualityFor

void setEqualityFor(java.lang.String typeIdOf,
                    java.lang.String typeIdTo)

Sets equality of two models to make sure, that models will be treated as one

Parameters:

typeIdOf - - id of current model type

typeIdTo - - id of existing model type