Package springfox.documentation.spi.service.contexts

Class ParameterContext

java.lang.Object

springfox.documentation.spi.service.contexts.ParameterContext

public class ParameterContext
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ParameterContext(springfox.documentation.service.ResolvedMethodParameter resolvedMethodParameter, DocumentationContext documentationContext, GenericTypeNamingStrategy genericNamingStrategy, OperationContext operationContext, int parameterIndex)

Method Summary

Modifier and Type	Method	Description
com.fasterxml.classmate.ResolvedType	alternateFor(com.fasterxml.classmate.ResolvedType parameterType)
AlternateTypeProvider	getAlternateTypeProvider()
DocumentationContext	getDocumentationContext()
DocumentationType	getDocumentationType()
GenericTypeNamingStrategy	getGenericNamingStrategy()
java.lang.String	getGroupName()
java.util.Set<java.lang.Class>	getIgnorableParameterTypes()
OperationContext	getOperationContext()
org.springframework.core.MethodParameter	methodParameter()	Deprecated. Use resolvedMethodParameter() instead
springfox.documentation.builders.ParameterBuilder	parameterBuilder()	Deprecated.
springfox.documentation.builders.RequestParameterBuilder	requestParameterBuilder()
springfox.documentation.service.ResolvedMethodParameter	resolvedMethodParameter()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterContext

public ParameterContext(springfox.documentation.service.ResolvedMethodParameter resolvedMethodParameter,
                        DocumentationContext documentationContext,
                        GenericTypeNamingStrategy genericNamingStrategy,
                        OperationContext operationContext,
                        int parameterIndex)

Method Detail

resolvedMethodParameter

public springfox.documentation.service.ResolvedMethodParameter resolvedMethodParameter()

methodParameter

@Deprecated
public org.springframework.core.MethodParameter methodParameter()

Deprecated.

Use resolvedMethodParameter() instead

Returns:

method parameter

Since:

2.5.0 this has been deprecated

parameterBuilder

@Deprecated
public springfox.documentation.builders.ParameterBuilder parameterBuilder()

Deprecated.

Returns:

this

Since:

3.0.0 this has been deprecated in favor of @see

requestParameterBuilder

public springfox.documentation.builders.RequestParameterBuilder requestParameterBuilder()

getDocumentationContext

public DocumentationContext getDocumentationContext()

getDocumentationType

public DocumentationType getDocumentationType()

alternateFor

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

getAlternateTypeProvider

public AlternateTypeProvider getAlternateTypeProvider()

getGenericNamingStrategy

public GenericTypeNamingStrategy getGenericNamingStrategy()

getOperationContext

public OperationContext getOperationContext()

getIgnorableParameterTypes

public java.util.Set<java.lang.Class> getIgnorableParameterTypes()

getGroupName

public java.lang.String getGroupName()