springfox.documentation

Interface RequestHandler

All Known Implementing Classes:

CombinedRequestHandler, WebMvcRequestHandler

public interface RequestHandler

Method Summary

Modifier and Type	Method and Description
RequestHandler	combine(RequestHandler other) This is to merge two request handlers that are indistinguishable other than the media types supported
java.util.Set<? extends org.springframework.http.MediaType>	consumes()
java.lang.Class<?>	declaringClass() Deprecated. @since 2.7.0 This is introduced to preserve backwards compat with groups
<T extends java.lang.annotation.Annotation> com.google.common.base.Optional<T>	findAnnotation(java.lang.Class<T> annotation)
<T extends java.lang.annotation.Annotation> com.google.common.base.Optional<T>	findControllerAnnotation(java.lang.Class<T> annotation)
org.springframework.web.method.HandlerMethod	getHandlerMethod() Deprecated. This is introduced to preserve backwards compat
java.lang.String	getName()
java.util.List<ResolvedMethodParameter>	getParameters()
org.springframework.web.servlet.mvc.condition.PatternsRequestCondition	getPatternsCondition()
org.springframework.web.servlet.mvc.method.RequestMappingInfo	getRequestMapping() Deprecated. This is introduced to preserve backwards compat
com.fasterxml.classmate.ResolvedType	getReturnType()
java.lang.String	groupName()
java.util.Set<org.springframework.web.servlet.mvc.condition.NameValueExpression<java.lang.String>>	headers()
boolean	isAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
RequestHandlerKey	key()
java.util.Set<org.springframework.web.servlet.mvc.condition.NameValueExpression<java.lang.String>>	params()
java.util.Set<? extends org.springframework.http.MediaType>	produces()
java.util.Set<org.springframework.web.bind.annotation.RequestMethod>	supportedMethods()

Method Detail

declaringClass

@Deprecated
java.lang.Class<?> declaringClass()

Deprecated. @since 2.7.0 This is introduced to preserve backwards compat with groups

Returns:

declaring class

isAnnotatedWith

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

getPatternsCondition

org.springframework.web.servlet.mvc.condition.PatternsRequestCondition getPatternsCondition()

groupName

java.lang.String groupName()

getName

java.lang.String getName()

supportedMethods

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

produces

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

consumes

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

headers

java.util.Set<org.springframework.web.servlet.mvc.condition.NameValueExpression<java.lang.String>> headers()

params

java.util.Set<org.springframework.web.servlet.mvc.condition.NameValueExpression<java.lang.String>> params()

findAnnotation

<T extends java.lang.annotation.Annotation> com.google.common.base.Optional<T> findAnnotation(java.lang.Class<T> annotation)

key

RequestHandlerKey key()

getParameters

java.util.List<ResolvedMethodParameter> getParameters()

getReturnType

com.fasterxml.classmate.ResolvedType getReturnType()

findControllerAnnotation

<T extends java.lang.annotation.Annotation> com.google.common.base.Optional<T> findControllerAnnotation(java.lang.Class<T> annotation)

getRequestMapping

@Deprecated
org.springframework.web.servlet.mvc.method.RequestMappingInfo getRequestMapping()

Deprecated. This is introduced to preserve backwards compat

Returns:

request mapping info

getHandlerMethod

@Deprecated
org.springframework.web.method.HandlerMethod getHandlerMethod()

Deprecated. This is introduced to preserve backwards compat

Returns:

handler method

combine

RequestHandler combine(RequestHandler other)

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

Parameters:

other - handler

Returns:

combined request handler

Since:

2.5.0