cn.hutool.core.annotation.scanner

接口 AnnotationScanner

所有已知实现类:

FieldAnnotationScanner, MetaAnnotationScanner, MethodAnnotationScanner, TypeAnnotationScanner

public interface AnnotationScanner

注解扫描器，用于从支持的可注解元素上获取所需注解

作者:

huangchengxing

另请参阅:

TypeAnnotationScanner, MethodAnnotationScanner, FieldAnnotationScanner, MetaAnnotationScanner

方法概要

限定符和类型	方法和说明
List<Annotation>	getAnnotations(AnnotatedElement annotatedElement) 获取可注解元素上的全部注解。
default List<Annotation>	getIfSupport(AnnotatedElement annotatedElement) 若support(AnnotatedElement)返回true， 则调用并返回getAnnotations(AnnotatedElement)结果， 否则返回Collections.emptyList()
static List<Annotation>	scanByAllScanner(AnnotatedElement annotatedElement, AnnotationScanner... scanners) 根据指定的扫描器，扫描元素上可能存在的注解
static List<Annotation>	scanByAnySupported(AnnotatedElement annotatedElement, AnnotationScanner... scanners) 给定一组扫描器，使用第一个支持处理该类型元素的扫描器获取元素上可能存在的注解
default boolean	support(AnnotatedElement annotatedElement) 是否支持扫描该可注解元素

方法详细资料

support

default boolean support(AnnotatedElement annotatedElement)

是否支持扫描该可注解元素

参数:

annotatedElement - 可注解元素

返回:

是否支持扫描该可注解元素

getAnnotations

List<Annotation> getAnnotations(AnnotatedElement annotatedElement)

获取可注解元素上的全部注解。调用该方法前，需要确保调用support(AnnotatedElement)返回为true

参数:

annotatedElement - 可注解元素

返回:

元素上的注解

getIfSupport

default List<Annotation> getIfSupport(AnnotatedElement annotatedElement)

若support(AnnotatedElement)返回true， 则调用并返回getAnnotations(AnnotatedElement)结果， 否则返回Collections.emptyList()

参数:

annotatedElement - 元素

返回:

元素上的注解

scanByAnySupported

static List<Annotation> scanByAnySupported(AnnotatedElement annotatedElement,
                                           AnnotationScanner... scanners)

给定一组扫描器，使用第一个支持处理该类型元素的扫描器获取元素上可能存在的注解

参数:

annotatedElement - 可注解元素

scanners - 注解扫描器

返回:

注解

scanByAllScanner

static List<Annotation> scanByAllScanner(AnnotatedElement annotatedElement,
                                         AnnotationScanner... scanners)

根据指定的扫描器，扫描元素上可能存在的注解

参数:

annotatedElement - 可注解元素

scanners - 注解扫描器

返回:

注解