程序包 cn.taketoday.core.annotation

类 MergedAnnotations.Search

java.lang.Object

cn.taketoday.core.annotation.MergedAnnotations.Search

封闭接口:

MergedAnnotations

public static final class MergedAnnotations.Search
extends Object

Fluent API for configuring the search algorithm used in the MergedAnnotations model and performing a search.

• Configuration starts with an invocation of MergedAnnotations.search(SearchStrategy), specifying which MergedAnnotations.SearchStrategy to use.
• Optional configuration can be provided via one of the with*() methods.
• The actual search is performed by invoking from(AnnotatedElement) with the source element from which the search should begin.

For example, the following performs a search on MyClass within the entire type hierarchy of that class while ignoring repeatable annotations.

 MergedAnnotations mergedAnnotations =
     MergedAnnotations.search(SearchStrategy.TYPE_HIERARCHY)
         .withRepeatableContainers(RepeatableContainers.none())
         .from(MyClass.class);
 

If you wish to reuse search configuration to perform the same type of search on multiple elements, you can save the Search instance as demonstrated in the following example.

 Search search = MergedAnnotations.search(SearchStrategy.TYPE_HIERARCHY)
                     .withRepeatableContainers(RepeatableContainers.none());

 MergedAnnotations mergedAnnotations = search.from(MyClass.class);
 // do something with the MergedAnnotations for MyClass
 mergedAnnotations = search.from(AnotherClass.class);
 // do something with the MergedAnnotations for AnotherClass
 

方法概要

修饰符和类型	方法	说明
MergedAnnotations	from(AnnotatedElement element)	Perform a search for merged annotations beginning with the supplied AnnotatedElement (such as a Class or Method), using the configuration in this Search instance.
MergedAnnotations.Search	withAnnotationFilter(AnnotationFilter annotationFilter)	Configure the AnnotationFilter to use.
MergedAnnotations.Search	withRepeatableContainers(RepeatableContainers repeatableContainers)	Configure the RepeatableContainers to use.

从类继承的方法 java.lang.Object

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

方法详细资料

withRepeatableContainers

public MergedAnnotations.Search withRepeatableContainers(RepeatableContainers repeatableContainers)

Configure the RepeatableContainers to use.

Defaults to RepeatableContainers.standard().

参数:

repeatableContainers - the repeatable containers that may be used by annotations or meta-annotations

返回:

this Search instance for chained method invocations

另请参阅:

• withAnnotationFilter(AnnotationFilter)
• from(AnnotatedElement)

withAnnotationFilter

public MergedAnnotations.Search withAnnotationFilter(AnnotationFilter annotationFilter)

Configure the AnnotationFilter to use.

Defaults to AnnotationFilter.PLAIN.

参数:

annotationFilter - an annotation filter used to restrict the annotations considered

返回:

this Search instance for chained method invocations

另请参阅:

• withRepeatableContainers(RepeatableContainers)
• from(AnnotatedElement)

from

public MergedAnnotations from(AnnotatedElement element)

Perform a search for merged annotations beginning with the supplied AnnotatedElement (such as a Class or Method), using the configuration in this Search instance.

参数:

element - the source element

返回:

a new MergedAnnotations instance containing all annotations and meta-annotations from the specified element and, depending on the MergedAnnotations.SearchStrategy, related inherited elements

另请参阅:

• withRepeatableContainers(RepeatableContainers)
• withAnnotationFilter(AnnotationFilter)
• MergedAnnotations.from(AnnotatedElement, SearchStrategy, RepeatableContainers, AnnotationFilter)