cn.hutool.core.annotation.scanner

Class TypeAnnotationScanner

java.lang.Object

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

cn.hutool.core.annotation.scanner.TypeAnnotationScanner

All Implemented Interfaces:

AnnotationScanner

public class TypeAnnotationScanner
extends AbstractTypeAnnotationScanner<TypeAnnotationScanner>
implements AnnotationScanner

扫描Class上的注解

Author:

huangchengxing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TypeAnnotationScanner.JdkProxyClassConverter 若类型为jdk代理类，则尝试转换为原始被代理类

Field Summary

Fields inherited from interface 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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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

Methods inherited from class cn.hutool.core.annotation.scanner.AbstractTypeAnnotationScanner

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface cn.hutool.core.annotation.scanner.AnnotationScanner

getAnnotations, getAnnotationsIfSupport, scan, scanByAllSupported, scanByAnySupported, scanIfSupport

Constructor Detail

TypeAnnotationScanner

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

构造一个类注解扫描器

Parameters:

includeSupperClass - 是否允许扫描父类

includeInterfaces - 是否允许扫描父接口

filter - 过滤器

excludeTypes - 不包含的类型

TypeAnnotationScanner

public TypeAnnotationScanner()

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

Method Detail

support

public boolean support(AnnotatedElement annotatedEle)

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

Specified by:

support in interface AnnotationScanner

Parameters:

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

Returns:

是否支持扫描该注解元素

getClassFormAnnotatedElement

protected Class<?> getClassFormAnnotatedElement(AnnotatedElement annotatedEle)

将注解元素转为Class

Specified by:

getClassFormAnnotatedElement in class AbstractTypeAnnotationScanner<TypeAnnotationScanner>

Parameters:

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

Returns:

要递归的类型

getAnnotationsFromTargetClass

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

获取Class.getAnnotations()

Specified by:

getAnnotationsFromTargetClass in class AbstractTypeAnnotationScanner<TypeAnnotationScanner>

Parameters:

source - 最初的注解元素

index - 类的层级索引

targetClass - 类

Returns:

类上直接声明的注解

setIncludeSuperClass

public TypeAnnotationScanner setIncludeSuperClass(boolean includeSuperClass)

是否允许扫描父类

Overrides:

setIncludeSuperClass in class AbstractTypeAnnotationScanner<TypeAnnotationScanner>

Parameters:

includeSuperClass - 是否允许扫描父类

Returns:

当前实例

setIncludeInterfaces

public TypeAnnotationScanner setIncludeInterfaces(boolean includeInterfaces)

是否允许扫描父接口

Overrides:

setIncludeInterfaces in class AbstractTypeAnnotationScanner<TypeAnnotationScanner>

Parameters:

includeInterfaces - 是否允许扫描父类

Returns:

当前实例