Package springfox.documentation.spring.web

Class WebMvcRequestHandler

java.lang.Object

springfox.documentation.spring.web.WebMvcRequestHandler

All Implemented Interfaces:

java.lang.Comparable<RequestHandler>, RequestHandler

Direct Known Subclasses:

SpringIntegrationWebMvcRequestHandler

public class WebMvcRequestHandler
extends java.lang.Object
implements RequestHandler

Constructor Summary

Constructors

Constructor	Description
WebMvcRequestHandler(java.lang.String contextPath, HandlerMethodResolver methodResolver, org.springframework.web.servlet.mvc.method.RequestMappingInfo requestMapping, org.springframework.web.method.HandlerMethod handlerMethod)

Method Summary

Modifier and Type	Method	Description
RequestHandler	combine(RequestHandler other)	This is to merge two request handlers that are indistinguishable other than the media types supported
java.util.Set<org.springframework.http.MediaType>	consumes()
java.lang.Class<?>	declaringClass()
<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)
org.springframework.web.method.HandlerMethod	getHandlerMethod()
java.lang.String	getName()
java.util.List<ResolvedMethodParameter>	getParameters()
PatternsRequestCondition	getPatternsCondition()
RequestMappingInfo<?>	getRequestMapping()
com.fasterxml.classmate.ResolvedType	getReturnType()
java.lang.String	groupName()
java.util.Set<NameValueExpression<java.lang.String>>	headers()
boolean	isAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
RequestHandlerKey	key()
java.util.Set<NameValueExpression<java.lang.String>>	params()
java.util.Set<org.springframework.http.MediaType>	produces()
java.util.Set<org.springframework.web.bind.annotation.RequestMethod>	supportedMethods()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface springfox.documentation.RequestHandler

compareTo

Constructor Detail

WebMvcRequestHandler

public WebMvcRequestHandler(java.lang.String contextPath,
                            HandlerMethodResolver methodResolver,
                            org.springframework.web.servlet.mvc.method.RequestMappingInfo requestMapping,
                            org.springframework.web.method.HandlerMethod handlerMethod)

Method Detail

getHandlerMethod

public org.springframework.web.method.HandlerMethod getHandlerMethod()

Specified by:

getHandlerMethod in interface RequestHandler

Returns:

handler method

combine

public RequestHandler combine(RequestHandler other)

Description copied from interface: RequestHandler

This is to merge two request handlers that are indistinguishable other than the media types supported

Specified by:

combine in interface RequestHandler

Parameters:

other - handler

Returns:

combined request handler

declaringClass

public java.lang.Class<?> declaringClass()

Specified by:

declaringClass in interface RequestHandler

Returns:

declaring class

isAnnotatedWith

public boolean isAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

Specified by:

isAnnotatedWith in interface RequestHandler

getPatternsCondition

public PatternsRequestCondition getPatternsCondition()

Specified by:

getPatternsCondition in interface RequestHandler

groupName

public java.lang.String groupName()

Specified by:

groupName in interface RequestHandler

getName

public java.lang.String getName()

Specified by:

getName in interface RequestHandler

supportedMethods

public java.util.Set<org.springframework.web.bind.annotation.RequestMethod> supportedMethods()

Specified by:

supportedMethods in interface RequestHandler

produces

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

Specified by:

produces in interface RequestHandler

consumes

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

Specified by:

consumes in interface RequestHandler

headers

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

Specified by:

headers in interface RequestHandler

params

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

Specified by:

params in interface RequestHandler

findAnnotation

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

Specified by:

findAnnotation in interface RequestHandler

key

public RequestHandlerKey key()

Specified by:

key in interface RequestHandler

getRequestMapping

public RequestMappingInfo<?> getRequestMapping()

Specified by:

getRequestMapping in interface RequestHandler

Returns:

request mapping info

getParameters

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

Specified by:

getParameters in interface RequestHandler

getReturnType

public com.fasterxml.classmate.ResolvedType getReturnType()

Specified by:

getReturnType in interface RequestHandler

findControllerAnnotation

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

Specified by:

findControllerAnnotation in interface RequestHandler

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object