springfox.documentation

Interface RequestHandler

All Superinterfaces:

java.lang.Comparable<RequestHandler>

All Known Implementing Classes:

CombinedRequestHandler, SpringIntegrationWebFluxRequestHandler, SpringIntegrationWebMvcRequestHandler, WebFluxRequestHandler, WebMvcRequestHandler

public interface RequestHandler
extends java.lang.Comparable<RequestHandler>

Method Summary

Modifier and Type	Method and Description
static java.util.Comparator<RequestHandler>	byOperationName()
static java.util.Comparator<RequestHandler>	byPatternsCondition()
RequestHandler	combine(RequestHandler other) This is to merge two request handlers that are indistinguishable other than the media types supported
default int	compareTo(RequestHandler other)
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> 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() Deprecated. This is introduced to preserve backwards compat
java.lang.String	getName()
java.util.List<ResolvedMethodParameter>	getParameters()
PatternsRequestCondition	getPatternsCondition()
RequestMappingInfo	getRequestMapping() Deprecated. This is introduced to preserve backwards compat
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<? extends org.springframework.http.MediaType>	produces()
static java.lang.String	sortedPaths(PatternsRequestCondition patternsCondition)
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

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<NameValueExpression<java.lang.String>> headers()

params

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

findAnnotation

<T extends java.lang.annotation.Annotation> java.util.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> java.util.Optional<T> findControllerAnnotation(java.lang.Class<T> annotation)

getRequestMapping

@Deprecated
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

compareTo

default int compareTo(RequestHandler other)

Specified by:

compareTo in interface java.lang.Comparable<RequestHandler>

sortedPaths

static java.lang.String sortedPaths(PatternsRequestCondition patternsCondition)

byPatternsCondition

static java.util.Comparator<RequestHandler> byPatternsCondition()

byOperationName

static java.util.Comparator<RequestHandler> byOperationName()