Package springfox.documentation.spi.schema.contexts

Class ModelContext

java.lang.Object

springfox.documentation.spi.schema.contexts.ModelContext

public class ModelContext
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
com.fasterxml.classmate.ResolvedType	alternateEvaluatedType()
com.fasterxml.classmate.ResolvedType	alternateFor(com.fasterxml.classmate.ResolvedType resolved)
boolean	canIgnore(com.fasterxml.classmate.ResolvedType type)
ModelContext	copy()
java.lang.String	description()
boolean	equals(java.lang.Object o)
static ModelContext	fromParent(ModelContext context, com.fasterxml.classmate.ResolvedType input)	Convenience method to provide an new context for an input parameter
AlternateTypeProvider	getAlternateTypeProvider()
ModelBuilder	getBuilder()	Deprecated.
DocumentationType	getDocumentationType()
GenericTypeNamingStrategy	getGenericNamingStrategy()
java.lang.String	getGroupName()
java.lang.String	getModelId()
ModelSpecificationBuilder	getModelSpecificationBuilder()
java.lang.String	getParameterId()
com.fasterxml.classmate.ResolvedType	getType()
java.lang.String	getTypeId()
java.util.Set<com.fasterxml.classmate.ResolvedType>	getValidationGroups()
java.util.Optional<com.fasterxml.classmate.ResolvedType>	getView()
int	hashCode()
boolean	hasSeenBefore(com.fasterxml.classmate.ResolvedType resolvedType)	Answers the question, has the given type been processed?
static ModelContext	inputParam(java.lang.String parameterId, java.lang.String group, com.fasterxml.classmate.ResolvedType type, java.util.Optional<com.fasterxml.classmate.ResolvedType> view, java.util.Set<com.fasterxml.classmate.ResolvedType> validationGroups, DocumentationType documentationType, AlternateTypeProvider alternateTypeProvider, GenericTypeNamingStrategy genericNamingStrategy, java.util.Set<java.lang.Class> ignorableTypes)	Convenience method to provide an new context for an input parameter
boolean	isReturnType()
com.fasterxml.classmate.ResolvedType	resolvedType(com.fasterxml.classmate.TypeResolver resolver)
static ModelContext	returnValue(java.lang.String parameterId, java.lang.String groupName, com.fasterxml.classmate.ResolvedType type, java.util.Optional<com.fasterxml.classmate.ResolvedType> view, DocumentationType documentationType, AlternateTypeProvider alternateTypeProvider, GenericTypeNamingStrategy genericNamingStrategy, java.util.Set<java.lang.Class> ignorableTypes)	Convenience method to provide an new context for an return parameter
void	seen(com.fasterxml.classmate.ResolvedType resolvedType)

Methods inherited from class java.lang.Object

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

Method Detail

getType

public com.fasterxml.classmate.ResolvedType getType()

Returns:

type behind this context

getParameterId

public java.lang.String getParameterId()

Returns:

parameter id behind this context

getModelId

public java.lang.String getModelId()

Returns:

type id of model behind this context

getTypeId

public java.lang.String getTypeId()

Returns:

type id of type behind this context

resolvedType

public com.fasterxml.classmate.ResolvedType resolvedType(com.fasterxml.classmate.TypeResolver resolver)

Parameters:

resolver - - type resolved

Returns:

resolved type

isReturnType

public boolean isReturnType()

Returns:

is the context for a return type

getView

public java.util.Optional<com.fasterxml.classmate.ResolvedType> getView()

Returns:

view

getValidationGroups

public java.util.Set<com.fasterxml.classmate.ResolvedType> getValidationGroups()

Returns:

a set of jsr-303 validation groups

getAlternateTypeProvider

public AlternateTypeProvider getAlternateTypeProvider()

Returns:

alternate type provider that's available to this context

alternateFor

public com.fasterxml.classmate.ResolvedType alternateFor(com.fasterxml.classmate.ResolvedType resolved)

Parameters:

resolved - - type to find an alternate type for

Returns:

alternate type for given resolved type

alternateEvaluatedType

public com.fasterxml.classmate.ResolvedType alternateEvaluatedType()

Returns:

alternate type for given resolved type

getGroupName

public java.lang.String getGroupName()

Returns:

group name of the docket

inputParam

public static ModelContext inputParam(java.lang.String parameterId,
                                      java.lang.String group,
                                      com.fasterxml.classmate.ResolvedType type,
                                      java.util.Optional<com.fasterxml.classmate.ResolvedType> view,
                                      java.util.Set<com.fasterxml.classmate.ResolvedType> validationGroups,
                                      DocumentationType documentationType,
                                      AlternateTypeProvider alternateTypeProvider,
                                      GenericTypeNamingStrategy genericNamingStrategy,
                                      java.util.Set<java.lang.Class> ignorableTypes)

Convenience method to provide an new context for an input parameter

Parameters:

parameterId - - parameter id

group - - group name of the docket

type - - type

view - - view

validationGroups - - validation groups

documentationType - - for documentation type

alternateTypeProvider - - alternate type provider

genericNamingStrategy - - how generic types should be named

ignorableTypes - - types that can be ignored

Returns:

new context

returnValue

public static ModelContext returnValue(java.lang.String parameterId,
                                       java.lang.String groupName,
                                       com.fasterxml.classmate.ResolvedType type,
                                       java.util.Optional<com.fasterxml.classmate.ResolvedType> view,
                                       DocumentationType documentationType,
                                       AlternateTypeProvider alternateTypeProvider,
                                       GenericTypeNamingStrategy genericNamingStrategy,
                                       java.util.Set<java.lang.Class> ignorableTypes)

Convenience method to provide an new context for an return parameter

Parameters:

parameterId - - parameter id

groupName - - group name of the docket

type - - type

view - - view

documentationType - - for documentation type

alternateTypeProvider - - alternate type provider

genericNamingStrategy - - how generic types should be named

ignorableTypes - - types that can be ignored

Returns:

new context

fromParent

public static ModelContext fromParent(ModelContext context,
                                      com.fasterxml.classmate.ResolvedType input)

Convenience method to provide an new context for an input parameter

Parameters:

context - - parent context

input - - context for given input

Returns:

new context based on parent context for a given input

hasSeenBefore

public boolean hasSeenBefore(com.fasterxml.classmate.ResolvedType resolvedType)

Answers the question, has the given type been processed?

Parameters:

resolvedType - - type to check

Returns:

true or false

getDocumentationType

public DocumentationType getDocumentationType()

getGenericNamingStrategy

public GenericTypeNamingStrategy getGenericNamingStrategy()

getBuilder

@Deprecated
public ModelBuilder getBuilder()

Deprecated.

Use getModelSpecificationBuilder() instead

Returns:

ModelBuilder

Since:

3.0.0

getModelSpecificationBuilder

public ModelSpecificationBuilder getModelSpecificationBuilder()

seen

public void seen(com.fasterxml.classmate.ResolvedType resolvedType)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

description

public java.lang.String description()

canIgnore

public boolean canIgnore(com.fasterxml.classmate.ResolvedType type)

copy

public ModelContext copy()