Package springfox.documentation.spi.service.contexts

Class OperationContext

java.lang.Object

springfox.documentation.spi.service.contexts.OperationContext

public class OperationContext
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
OperationContext(OperationBuilder operationBuilder, org.springframework.web.bind.annotation.RequestMethod requestMethod, RequestMappingContext requestContext, int operationIndex)

Method Summary

Modifier and Type	Method	Description
com.fasterxml.classmate.ResolvedType	alternateFor(com.fasterxml.classmate.ResolvedType resolved)
java.util.Set<org.springframework.http.MediaType>	consumes()
<T extends java.lang.annotation.Annotation> java.util.List<T>	findAllAnnotations(java.lang.Class<T> annotation)
<T extends java.lang.annotation.Annotation> java.util.Optional<T>	findAnnotation(java.lang.Class<T> annotation)
<T extends java.lang.annotation.Annotation> java.util.Optional<T>	findControllerAnnotation(java.lang.Class<T> annotation)
AlternateTypeProvider	getAlternateTypeProvider()
DocumentationContext	getDocumentationContext()
DocumentationType	getDocumentationType()
GenericTypeNamingStrategy	getGenericsNamingStrategy()
java.util.List<Parameter>	getGlobalOperationParameters()	Deprecated.
java.util.List<RequestParameter>	getGlobalRequestParameters()
java.util.List<ResponseMessage>	getGlobalResponseMessages(java.lang.String forHttpMethod)
java.lang.String	getGroupName()
java.util.Set<java.lang.Class>	getIgnorableParameterTypes()
java.util.Map<java.lang.String,java.util.Set<Model>>	getKnownModels()
java.lang.String	getName()
java.util.List<ResolvedMethodParameter>	getParameters()
com.fasterxml.classmate.ResolvedType	getReturnType()
java.util.Collection<Response>	globalResponsesFor(org.springframework.http.HttpMethod httpMethod)
java.util.Set<NameValueExpression<java.lang.String>>	headers()
org.springframework.http.HttpMethod	httpMethod()
OperationBuilder	operationBuilder()
int	operationIndex()
OperationModelContextsBuilder	operationModelsBuilder()
java.util.Set<NameValueExpression<java.lang.String>>	params()
java.util.Set<org.springframework.http.MediaType>	produces()
java.lang.String	requestMappingPattern()
java.util.List<SecurityContext>	securityContext()

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationContext

public OperationContext(OperationBuilder operationBuilder,
                        org.springframework.web.bind.annotation.RequestMethod requestMethod,
                        RequestMappingContext requestContext,
                        int operationIndex)

Method Detail

operationBuilder

public OperationBuilder operationBuilder()

httpMethod

public org.springframework.http.HttpMethod httpMethod()

operationIndex

public int operationIndex()

getGlobalResponseMessages

public java.util.List<ResponseMessage> getGlobalResponseMessages(java.lang.String forHttpMethod)

getGlobalOperationParameters

@Deprecated
public java.util.List<Parameter> getGlobalOperationParameters()

Deprecated.

Use getGlobalRequestParameters() instead

Returns:

List

Since:

3.0

getGlobalRequestParameters

public java.util.List<RequestParameter> getGlobalRequestParameters()

securityContext

public java.util.List<SecurityContext> securityContext()

requestMappingPattern

public java.lang.String requestMappingPattern()

getDocumentationContext

public DocumentationContext getDocumentationContext()

operationModelsBuilder

public OperationModelContextsBuilder operationModelsBuilder()

getKnownModels

public java.util.Map<java.lang.String,java.util.Set<Model>> getKnownModels()

getDocumentationType

public DocumentationType getDocumentationType()

getAlternateTypeProvider

public AlternateTypeProvider getAlternateTypeProvider()

alternateFor

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

produces

public java.util.Set<org.springframework.http.MediaType> produces()

consumes

public java.util.Set<org.springframework.http.MediaType> consumes()

getIgnorableParameterTypes

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

getGenericsNamingStrategy

public GenericTypeNamingStrategy getGenericsNamingStrategy()

headers

public java.util.Set<NameValueExpression<java.lang.String>> headers()

params

public java.util.Set<NameValueExpression<java.lang.String>> params()

getName

public java.lang.String getName()

getGroupName

public java.lang.String getGroupName()

getParameters

public java.util.List<ResolvedMethodParameter> getParameters()

findAnnotation

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

getReturnType

public com.fasterxml.classmate.ResolvedType getReturnType()

findControllerAnnotation

public <T extends java.lang.annotation.Annotation> java.util.Optional<T> findControllerAnnotation(java.lang.Class<T> annotation)

findAllAnnotations

public <T extends java.lang.annotation.Annotation> java.util.List<T> findAllAnnotations(java.lang.Class<T> annotation)

globalResponsesFor

public java.util.Collection<Response> globalResponsesFor(org.springframework.http.HttpMethod httpMethod)