cn.hutool.core.annotation.scanner

类 TypeAnnotationScanner

java.lang.Object

cn.hutool.core.annotation.scanner.TypeAnnotationScanner

所有已实现的接口:

AnnotationScanner

public class TypeAnnotationScanner
extends Object
implements AnnotationScanner

扫描Class上的注解

作者:

huangchengxing

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	TypeAnnotationScanner.JdkProxyClassConverter 若类型为jdk代理类，则尝试转换为原始被代理类

构造器概要

构造器

构造器和说明
TypeAnnotationScanner() 构建一个类注解扫描器，默认允许扫描指定元素的父类以及父接口
TypeAnnotationScanner(boolean includeSupperClass, boolean includeInterfaces, Predicate<Class<?>> filter, Set<Class<?>> excludeTypes) 构造一个类注解扫描器

方法概要

限定符和类型	方法和说明
TypeAnnotationScanner	addConverters(UnaryOperator<Class<?>> converter) 添加转换器
TypeAnnotationScanner	addExcludeTypes(Class<?>... excludeTypes) 添加不扫描的类型，该类型及其树结构将直接不被查找
List<Annotation>	getAnnotations(AnnotatedElement annotatedElement) 获取可注解元素上的全部注解。
boolean	isIncludeInterfaces() 是否允许扫描父接口
boolean	isIncludeSupperClass() 是否允许扫描父类
TypeAnnotationScanner	setFilter(Predicate<Class<?>> filter) 设置过滤器，若类型无法通过该过滤器，则该类型及其树结构将直接不被查找
TypeAnnotationScanner	setIncludeInterfaces(boolean includeInterfaces) 是否允许扫描父接口
TypeAnnotationScanner	setIncludeSupperClass(boolean includeSupperClass) 是否允许扫描父类
boolean	support(AnnotatedElement annotatedElement) 是否支持扫描该可注解元素

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

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

从接口继承的方法 cn.hutool.core.annotation.scanner.AnnotationScanner

getIfSupport, scanByAllScanner, scanByAnySupported

构造器详细资料

TypeAnnotationScanner

public TypeAnnotationScanner(boolean includeSupperClass,
                             boolean includeInterfaces,
                             Predicate<Class<?>> filter,
                             Set<Class<?>> excludeTypes)

构造一个类注解扫描器

参数:

includeSupperClass - 是否允许扫描父类

includeInterfaces - 是否允许扫描父接口

filter - 过滤器

excludeTypes - 不包含的类型

TypeAnnotationScanner

public TypeAnnotationScanner()

构建一个类注解扫描器，默认允许扫描指定元素的父类以及父接口

方法详细资料

isIncludeSupperClass

public boolean isIncludeSupperClass()

是否允许扫描父类

返回:

是否允许扫描父类

isIncludeInterfaces

public boolean isIncludeInterfaces()

是否允许扫描父接口

返回:

是否允许扫描父接口

setFilter

public TypeAnnotationScanner setFilter(Predicate<Class<?>> filter)

设置过滤器，若类型无法通过该过滤器，则该类型及其树结构将直接不被查找

参数:

filter - 过滤器

返回:

当前实例

addExcludeTypes

public TypeAnnotationScanner addExcludeTypes(Class<?>... excludeTypes)

添加不扫描的类型，该类型及其树结构将直接不被查找

参数:

excludeTypes - 不扫描的类型

返回:

当前实例

addConverters

public TypeAnnotationScanner addConverters(UnaryOperator<Class<?>> converter)

添加转换器

参数:

converter - 转换器

返回:

当前实例

另请参阅:

TypeAnnotationScanner.JdkProxyClassConverter

setIncludeSupperClass

public TypeAnnotationScanner setIncludeSupperClass(boolean includeSupperClass)

是否允许扫描父类

参数:

includeSupperClass - 是否

返回:

当前实例

setIncludeInterfaces

public TypeAnnotationScanner setIncludeInterfaces(boolean includeInterfaces)

是否允许扫描父接口

参数:

includeInterfaces - 是否

返回:

当前实例

support

public boolean support(AnnotatedElement annotatedElement)

从接口复制的说明: AnnotationScanner

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

指定者:

support 在接口中 AnnotationScanner

参数:

annotatedElement - 可注解元素

返回:

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

getAnnotations

public List<Annotation> getAnnotations(AnnotatedElement annotatedElement)

从接口复制的说明: AnnotationScanner

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

指定者:

getAnnotations 在接口中 AnnotationScanner

参数:

annotatedElement - 可注解元素

返回:

元素上的注解