Package springfox.documentation.spi.service.contexts

Class ParameterExpansionContext

java.lang.Object

springfox.documentation.spi.service.contexts.ParameterExpansionContext

public class ParameterExpansionContext
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ParameterExpansionContext(java.lang.String dataTypeName, java.lang.String parentName, java.lang.String parameterType, ParameterMetadataAccessor metadataAccessor, DocumentationType documentationType, springfox.documentation.builders.ParameterBuilder parameterBuilder, springfox.documentation.builders.RequestParameterBuilder requestParameterBuilder)

Method Summary

Modifier and Type	Method	Description
<A extends java.lang.annotation.Annotation> java.util.Optional<A>	findAnnotation(java.lang.Class<A> annotationType)
java.lang.String	getDataTypeName()
DocumentationType	getDocumentationType()
com.fasterxml.classmate.members.ResolvedField	getField()	Deprecated.
java.lang.String	getFieldName()
com.fasterxml.classmate.ResolvedType	getFieldType()
springfox.documentation.builders.ParameterBuilder	getParameterBuilder()
java.lang.String	getParameterType()
java.lang.String	getParentName()
springfox.documentation.builders.RequestParameterBuilder	getRequestParameterBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterExpansionContext

public ParameterExpansionContext(java.lang.String dataTypeName,
                                 java.lang.String parentName,
                                 java.lang.String parameterType,
                                 ParameterMetadataAccessor metadataAccessor,
                                 DocumentationType documentationType,
                                 springfox.documentation.builders.ParameterBuilder parameterBuilder,
                                 springfox.documentation.builders.RequestParameterBuilder requestParameterBuilder)

Method Detail

getDataTypeName

public java.lang.String getDataTypeName()

getParentName

public java.lang.String getParentName()

getParameterType

public java.lang.String getParameterType()

getField

@Deprecated
public com.fasterxml.classmate.members.ResolvedField getField()

Deprecated.

Access to the raw field is deprecated to support interface based model attributes with resolvers e.g. Pageable

Returns:

resolved field

Since:

2.8.0

getDocumentationType

public DocumentationType getDocumentationType()

getParameterBuilder

public springfox.documentation.builders.ParameterBuilder getParameterBuilder()

getRequestParameterBuilder

public springfox.documentation.builders.RequestParameterBuilder getRequestParameterBuilder()

getFieldType

public com.fasterxml.classmate.ResolvedType getFieldType()

getFieldName

public java.lang.String getFieldName()

findAnnotation

public <A extends java.lang.annotation.Annotation> java.util.Optional<A> findAnnotation(java.lang.Class<A> annotationType)