cn.hutool.core.annotation.scanner

Class MethodAnnotationScanner

java.lang.Object

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

cn.hutool.core.annotation.scanner.MethodAnnotationScanner

All Implemented Interfaces:

AnnotationScanner

public class MethodAnnotationScanner
extends AbstractTypeAnnotationScanner<MethodAnnotationScanner>
implements AnnotationScanner

扫描Method上的注解

Author:

huangchengxing

Nested Class Summary

Nested classes/interfaces inherited from class cn.hutool.core.annotation.scanner.AbstractTypeAnnotationScanner

AbstractTypeAnnotationScanner.JdkProxyClassConverter

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
MethodAnnotationScanner() 构造一个类注解扫描器，仅扫描该方法上直接声明的注解
MethodAnnotationScanner(boolean scanSameSignatureMethod) 构造一个类注解扫描器
MethodAnnotationScanner(boolean includeSuperClass, boolean includeInterfaces, Predicate<Class<?>> filter, Set<Class<?>> excludeTypes) 构造一个方法注解扫描器
MethodAnnotationScanner(boolean scanSameSignatureMethod, Predicate<Class<?>> filter, Set<Class<?>> excludeTypes) 构造一个方法注解扫描器

Method Summary

Modifier and Type	Method and Description
protected Annotation[]	getAnnotationsFromTargetClass(AnnotatedElement source, int index, Class<?> targetClass) 若父类/父接口中方法具有相同的方法签名，则返回该方法上的注解
protected Class<?>	getClassFormAnnotatedElement(AnnotatedElement annotatedElement) 获取声明该方法的类
MethodAnnotationScanner	setScanSameSignatureMethod(boolean scanSuperMethodIfOverride) 设置是否扫描类层级结构中具有相同方法签名的方法
boolean	support(AnnotatedElement annotatedEle) 判断是否支持扫描该注解元素，仅当注解元素是Method时返回true

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

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

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

MethodAnnotationScanner

public MethodAnnotationScanner()

构造一个类注解扫描器，仅扫描该方法上直接声明的注解

MethodAnnotationScanner

public MethodAnnotationScanner(boolean scanSameSignatureMethod)

构造一个类注解扫描器

Parameters:

scanSameSignatureMethod - 是否扫描类层级结构中具有相同方法签名的方法

MethodAnnotationScanner

public MethodAnnotationScanner(boolean scanSameSignatureMethod,
                               Predicate<Class<?>> filter,
                               Set<Class<?>> excludeTypes)

构造一个方法注解扫描器

Parameters:

scanSameSignatureMethod - 是否扫描类层级结构中具有相同方法签名的方法

filter - 过滤器

excludeTypes - 不包含的类型

MethodAnnotationScanner

public MethodAnnotationScanner(boolean includeSuperClass,
                               boolean includeInterfaces,
                               Predicate<Class<?>> filter,
                               Set<Class<?>> excludeTypes)

构造一个方法注解扫描器

Parameters:

includeSuperClass - 是否允许扫描父类中具有相同方法签名的方法

includeInterfaces - 是否允许扫描父接口中具有相同方法签名的方法

filter - 过滤器

excludeTypes - 不包含的类型

Method Detail

support

public boolean support(AnnotatedElement annotatedEle)

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

Specified by:

support in interface AnnotationScanner

Parameters:

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

Returns:

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

getClassFormAnnotatedElement

protected Class<?> getClassFormAnnotatedElement(AnnotatedElement annotatedElement)

获取声明该方法的类

Specified by:

getClassFormAnnotatedElement in class AbstractTypeAnnotationScanner<MethodAnnotationScanner>

Parameters:

annotatedElement - 注解元素

Returns:

要递归的类型

See Also:

Method.getDeclaringClass()

getAnnotationsFromTargetClass

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

若父类/父接口中方法具有相同的方法签名，则返回该方法上的注解

Specified by:

getAnnotationsFromTargetClass in class AbstractTypeAnnotationScanner<MethodAnnotationScanner>

Parameters:

source - 原始方法

index - 类的层级索引

targetClass - 类

Returns:

最终所需的目标注解

setScanSameSignatureMethod

public MethodAnnotationScanner setScanSameSignatureMethod(boolean scanSuperMethodIfOverride)

设置是否扫描类层级结构中具有相同方法签名的方法

Parameters:

scanSuperMethodIfOverride - 是否扫描类层级结构中具有相同方法签名的方法

Returns:

当前实例