cn.hutool.core.annotation.scanner

类 TypeAnnotationScanner

java.lang.Object

cn.hutool.core.annotation.scanner.AbstractTypeAnnotationScanner<TypeAnnotationScanner>

cn.hutool.core.annotation.scanner.TypeAnnotationScanner

所有已实现的接口:

AnnotationScanner

public class TypeAnnotationScanner
extends AbstractTypeAnnotationScanner<TypeAnnotationScanner>
implements AnnotationScanner

扫描Class上的注解

作者:

huangchengxing

嵌套类概要

嵌套类

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

字段概要

从接口继承的字段 cn.hutool.core.annotation.scanner.AnnotationScanner

DIRECTLY, DIRECTLY_AND_META_ANNOTATION, INTERFACE, INTERFACE_AND_META_ANNOTATION, NOTHING, SUPERCLASS, SUPERCLASS_AND_META_ANNOTATION, TYPE_HIERARCHY, TYPE_HIERARCHY_AND_META_ANNOTATION

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
protected Annotation[]	getAnnotationsFromTargetClass(AnnotatedElement source, int index, Class<?> targetClass) 获取Class.getAnnotations()
protected Class<?>	getClassFormAnnotatedElement(AnnotatedElement annotatedEle) 将注解元素转为Class
TypeAnnotationScanner	setIncludeInterfaces(boolean includeInterfaces) 是否允许扫描父接口
TypeAnnotationScanner	setIncludeSuperClass(boolean includeSuperClass) 是否允许扫描父类
boolean	support(AnnotatedElement annotatedEle) 判断是否支持扫描该注解元素，仅当注解元素是Class接时返回true

从类继承的方法 cn.hutool.core.annotation.scanner.AbstractTypeAnnotationScanner

addConverters, addExcludeTypes, convert, isIncludeInterfaces, isIncludeSuperClass, isNotNeedProcess, scan, scanInterfaceIfNecessary, scanSuperClassIfNecessary, setFilter

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

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

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

getAnnotations, getAnnotationsIfSupport, scan, scanByAllSupported, scanByAnySupported, scanIfSupport

构造器详细资料

TypeAnnotationScanner

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

构造一个类注解扫描器

参数:

includeSupperClass - 是否允许扫描父类

includeInterfaces - 是否允许扫描父接口

filter - 过滤器

excludeTypes - 不包含的类型

TypeAnnotationScanner

public TypeAnnotationScanner()

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

方法详细资料

support

public boolean support(AnnotatedElement annotatedEle)

判断是否支持扫描该注解元素，仅当注解元素是Class接时返回true

指定者:

support 在接口中 AnnotationScanner

参数:

annotatedEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission

返回:

是否支持扫描该注解元素

getClassFormAnnotatedElement

protected Class<?> getClassFormAnnotatedElement(AnnotatedElement annotatedEle)

将注解元素转为Class

指定者:

getClassFormAnnotatedElement 在类中 AbstractTypeAnnotationScanner<TypeAnnotationScanner>

参数:

annotatedEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission

返回:

要递归的类型

getAnnotationsFromTargetClass

protected Annotation[] getAnnotationsFromTargetClass(AnnotatedElement source,
                                                     int index,
                                                     Class<?> targetClass)

获取Class.getAnnotations()

指定者:

getAnnotationsFromTargetClass 在类中 AbstractTypeAnnotationScanner<TypeAnnotationScanner>

参数:

source - 最初的注解元素

index - 类的层级索引

targetClass - 类

返回:

类上直接声明的注解

setIncludeSuperClass

public TypeAnnotationScanner setIncludeSuperClass(boolean includeSuperClass)

是否允许扫描父类

覆盖:

setIncludeSuperClass 在类中 AbstractTypeAnnotationScanner<TypeAnnotationScanner>

参数:

includeSuperClass - 是否允许扫描父类

返回:

当前实例

setIncludeInterfaces

public TypeAnnotationScanner setIncludeInterfaces(boolean includeInterfaces)

是否允许扫描父接口

覆盖:

setIncludeInterfaces 在类中 AbstractTypeAnnotationScanner<TypeAnnotationScanner>

参数:

includeInterfaces - 是否允许扫描父类

返回:

当前实例