org.springframework.web.method

Class HandlerTypePredicate

java.lang.Object

org.springframework.web.method.HandlerTypePredicate

All Implemented Interfaces:

java.util.function.Predicate<java.lang.Class<?>>

public final class HandlerTypePredicate
extends java.lang.Object
implements java.util.function.Predicate<java.lang.Class<?>>

A Predicate to match request handling component types if any of the following selectors match:

• Base packages -- for selecting handlers by their package.
• Assignable types -- for selecting handlers by super type.
• Annotations -- for selecting handlers annotated in a specific way.

Composability methods on Predicate can be used :

 Predicate<Class<?>> predicate =
                HandlerTypePredicate.forAnnotation(RestController.class)
                                .and(HandlerTypePredicate.forBasePackage("org.example"));
 

Since:

5.1

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HandlerTypePredicate.Builder A HandlerTypePredicate builder.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>>	annotations
private java.util.List<java.lang.Class<?>>	assignableTypes
private java.util.Set<java.lang.String>	basePackages

Constructor Summary

Constructors

Modifier	Constructor and Description
private	HandlerTypePredicate(java.util.Set<java.lang.String> basePackages, java.util.List<java.lang.Class<?>> assignableTypes, java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations) Private constructor.

Method Summary

Modifier and Type	Method and Description
static HandlerTypePredicate.Builder	builder() Return a builder for a HandlerTypePredicate.
static HandlerTypePredicate	forAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation>... annotations) Match handlers annotated with a specific annotation.
static HandlerTypePredicate	forAnyHandlerType() Predicate that applies to any handlers.
static HandlerTypePredicate	forAssignableType(java.lang.Class<?>... types) Match handlers that are assignable to a given type.
static HandlerTypePredicate	forBasePackage(java.lang.String... packages) Match handlers declared under a base package, e.g.
static HandlerTypePredicate	forBasePackageClass(java.lang.Class<?>... packageClasses) Type-safe alternative to forBasePackage(String...) to specify a base package through a class.
private boolean	hasSelectors()
boolean	test(java.lang.Class<?> controllerType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Field Detail

basePackages

private final java.util.Set<java.lang.String> basePackages

assignableTypes

private final java.util.List<java.lang.Class<?>> assignableTypes

annotations

private final java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations

Constructor Detail

HandlerTypePredicate

private HandlerTypePredicate(java.util.Set<java.lang.String> basePackages,
                             java.util.List<java.lang.Class<?>> assignableTypes,
                             java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations)

Private constructor. See static factory methods.

Method Detail

test

public boolean test(java.lang.Class<?> controllerType)

Specified by:

test in interface java.util.function.Predicate<java.lang.Class<?>>

hasSelectors

private boolean hasSelectors()

forAnyHandlerType

public static HandlerTypePredicate forAnyHandlerType()

Predicate that applies to any handlers.

forBasePackage

public static HandlerTypePredicate forBasePackage(java.lang.String... packages)

Match handlers declared under a base package, e.g. "org.example".

Parameters:

packages - one or more base package names

forBasePackageClass

public static HandlerTypePredicate forBasePackageClass(java.lang.Class<?>... packageClasses)

Type-safe alternative to forBasePackage(String...) to specify a base package through a class.

Parameters:

packageClasses - one or more base package classes

forAssignableType

public static HandlerTypePredicate forAssignableType(java.lang.Class<?>... types)

Match handlers that are assignable to a given type.

Parameters:

types - one or more handler super types

forAnnotation

@SafeVarargs
public static HandlerTypePredicate forAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation>... annotations)

Match handlers annotated with a specific annotation.

Parameters:

annotations - one or more annotations to check for

builder

public static HandlerTypePredicate.Builder builder()

Return a builder for a HandlerTypePredicate.