org.springframework.core.annotation

Class MergedAnnotationPredicates

java.lang.Object

org.springframework.core.annotation.MergedAnnotationPredicates

public abstract class MergedAnnotationPredicates
extends java.lang.Object

Predicate implementations that provide various test operations for MergedAnnotations.

Since:

5.2

Author:

Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	MergedAnnotationPredicates.FirstRunOfPredicate<A extends java.lang.annotation.Annotation> Predicate implementation used for firstRunOf(Function).
private static class	MergedAnnotationPredicates.UniquePredicate<A extends java.lang.annotation.Annotation,K> Predicate implementation used for unique(Function).

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MergedAnnotationPredicates()

Method Summary

Modifier and Type	Method and Description
static <A extends java.lang.annotation.Annotation> java.util.function.Predicate<MergedAnnotation<A>>	firstRunOf(java.util.function.Function<? super MergedAnnotation<A>,?> valueExtractor) Create a new stateful, single use Predicate that matches only the first run of an extracted value.
static <A extends java.lang.annotation.Annotation> java.util.function.Predicate<MergedAnnotation<? extends A>>	typeIn(java.lang.Class<?>... types) Create a new Predicate that evaluates to true if the merged annotation type is contained in the specified array.
static <A extends java.lang.annotation.Annotation> java.util.function.Predicate<MergedAnnotation<? extends A>>	typeIn(java.util.Collection<?> types) Create a new Predicate that evaluates to true if the merged annotation type is contained in the collection.
static <A extends java.lang.annotation.Annotation> java.util.function.Predicate<MergedAnnotation<? extends A>>	typeIn(java.lang.String... typeNames) Create a new Predicate that evaluates to true if the merged annotation type is contained in the specified array.
static <A extends java.lang.annotation.Annotation,K> java.util.function.Predicate<MergedAnnotation<A>>	unique(java.util.function.Function<? super MergedAnnotation<A>,K> keyExtractor) Create a new stateful, single use Predicate that matches annotations that are unique based on the extracted key.

Methods inherited from class java.lang.Object

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

Constructor Detail

MergedAnnotationPredicates

private MergedAnnotationPredicates()

Method Detail

typeIn

public static <A extends java.lang.annotation.Annotation> java.util.function.Predicate<MergedAnnotation<? extends A>> typeIn(java.lang.String... typeNames)

Create a new Predicate that evaluates to true if the merged annotation type is contained in the specified array.

Type Parameters:

A - the annotation type

Parameters:

typeNames - the names that should be matched

Returns:

a Predicate to test the annotation type

typeIn

public static <A extends java.lang.annotation.Annotation> java.util.function.Predicate<MergedAnnotation<? extends A>> typeIn(java.lang.Class<?>... types)

Create a new Predicate that evaluates to true if the merged annotation type is contained in the specified array.

Type Parameters:

A - the annotation type

Parameters:

types - the types that should be matched

Returns:

a Predicate to test the annotation type

typeIn

public static <A extends java.lang.annotation.Annotation> java.util.function.Predicate<MergedAnnotation<? extends A>> typeIn(java.util.Collection<?> types)

Create a new Predicate that evaluates to true if the merged annotation type is contained in the collection.

Type Parameters:

A - the annotation type

Parameters:

types - the type names or classes that should be matched

Returns:

a Predicate to test the annotation type

firstRunOf

public static <A extends java.lang.annotation.Annotation> java.util.function.Predicate<MergedAnnotation<A>> firstRunOf(java.util.function.Function<? super MergedAnnotation<A>,?> valueExtractor)

Create a new stateful, single use Predicate that matches only the first run of an extracted value. For example, MergedAnnotationPredicates.firstRunOf(MergedAnnotation::depth) will return the first annotation and a subsequent run of the same depth.

NOTE: This predicate only matches the first first run. Once the extracted value changes, the predicate always returns false.

Parameters:

valueExtractor - function used to extract the value to check

Returns:

a Predicate that matches the first run of the extracted values

unique

public static <A extends java.lang.annotation.Annotation,K> java.util.function.Predicate<MergedAnnotation<A>> unique(java.util.function.Function<? super MergedAnnotation<A>,K> keyExtractor)

Create a new stateful, single use Predicate that matches annotations that are unique based on the extracted key. For example MergedAnnotationPredicates.unique(MergedAnnotation::type) will match the first time a unique type is encountered.

Parameters:

keyExtractor - function used to extract the key used to test for uniqueness

Returns:

a Predicate that matches a unique annotation based on the extracted key