springfox.documentation.builders

Class RequestHandlerSelectors

java.lang.Object

springfox.documentation.builders.RequestHandlerSelectors

public class RequestHandlerSelectors
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
static com.google.common.base.Predicate<RequestHandler>	any() Any RequestHandler satisfies this condition
static com.google.common.base.Predicate<RequestHandler>	basePackage(java.lang.String basePackage) Predicate that matches RequestHandler with given base package name for the class of the handler method.
static com.google.common.base.Predicate<RequestHandler>	none() No RequestHandler satisfies this condition
static com.google.common.base.Predicate<RequestHandler>	withClassAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Predicate that matches RequestHandler with given annotation on the declaring class of the handler method
static com.google.common.base.Predicate<RequestHandler>	withMethodAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Predicate that matches RequestHandler with handlers methods annotated with given annotation

Methods inherited from class java.lang.Object

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

Method Detail

any

public static com.google.common.base.Predicate<RequestHandler> any()

Any RequestHandler satisfies this condition

Returns:

predicate that is always true

none

public static com.google.common.base.Predicate<RequestHandler> none()

No RequestHandler satisfies this condition

Returns:

predicate that is always false

withMethodAnnotation

public static com.google.common.base.Predicate<RequestHandler> withMethodAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

Predicate that matches RequestHandler with handlers methods annotated with given annotation

Parameters:

annotation - - annotation to check

Returns:

this

withClassAnnotation

public static com.google.common.base.Predicate<RequestHandler> withClassAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

Predicate that matches RequestHandler with given annotation on the declaring class of the handler method

Parameters:

annotation - - annotation to check

Returns:

this

basePackage

public static com.google.common.base.Predicate<RequestHandler> basePackage(java.lang.String basePackage)

Predicate that matches RequestHandler with given base package name for the class of the handler method. This predicate includes all request handlers matching the provided basePackage

Parameters:

basePackage - - base package of the classes

Returns:

this