cz.ues.platform.apt.visitor

Class AnnotatedTypeElementScanner

java.lang.Object

javax.lang.model.util.AbstractElementVisitor6<R,P>

javax.lang.model.util.ElementScanner6<java.util.Set<javax.lang.model.element.TypeElement>,java.lang.Class<? extends java.lang.annotation.Annotation>>

cz.ues.platform.apt.visitor.AnnotatedTypeElementScanner

All Implemented Interfaces:

javax.lang.model.element.ElementVisitor<java.util.Set<javax.lang.model.element.TypeElement>,java.lang.Class<? extends java.lang.annotation.Annotation>>

public class AnnotatedTypeElementScanner
extends javax.lang.model.util.ElementScanner6<java.util.Set<javax.lang.model.element.TypeElement>,java.lang.Class<? extends java.lang.annotation.Annotation>>

APT visitor used to scan whole tree of classes referenced from class on which is visitor initiated. List of TypeElements representing classes annotated by annotation (or meta-annotation) given as visitor additional parameter is returned as result.

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<javax.lang.model.element.TypeElement>	annotatedClasses List of annotated classes to be returned.
private static java.lang.String	LANG_PREFIX Package prefix to be ignored for scanning.
private static java.lang.String	UTIL_PREFIX Package prefix to be ignored for scanning.
private java.util.Set<javax.lang.model.element.TypeElement>	visitedClasses List of visited classes (prevents cyclic scanning).

Fields inherited from class javax.lang.model.util.ElementScanner6

DEFAULT_VALUE

Constructor Summary

Constructors

Constructor and Description
AnnotatedTypeElementScanner() Creates new instance of AnnotatedClassScanner visitor.

Method Summary

Methods

Modifier and Type	Method and Description
private boolean	isAnnotated(javax.lang.model.element.TypeElement aElement, java.lang.Class<? extends java.lang.annotation.Annotation> aAnnotation) Checks if type element (class) is annotated with given annotation (either directly or using meta-annotation).
java.util.Set<javax.lang.model.element.TypeElement>	visitExecutable(javax.lang.model.element.ExecutableElement aElement, java.lang.Class<? extends java.lang.annotation.Annotation> aAnnotation) Visits executable element.
java.util.Set<javax.lang.model.element.TypeElement>	visitType(javax.lang.model.element.TypeElement aElement, java.lang.Class<? extends java.lang.annotation.Annotation> aAnnotation) Visits type element.
private void	visitTypeMirror(javax.lang.model.type.TypeMirror aType, java.lang.Class<? extends java.lang.annotation.Annotation> aAnnotation) Visits type mirror.
java.util.Set<javax.lang.model.element.TypeElement>	visitVariable(javax.lang.model.element.VariableElement aElement, java.lang.Class<? extends java.lang.annotation.Annotation> aAnnotation) Visits variable element.

Methods inherited from class javax.lang.model.util.ElementScanner6

scan, scan, scan, visitPackage, visitTypeParameter

Methods inherited from class javax.lang.model.util.AbstractElementVisitor6

visit, visit, visitUnknown

Methods inherited from class java.lang.Object

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

Field Detail

LANG_PREFIX

private static final LANG_PREFIX

Package prefix to be ignored for scanning.

See Also:

Constant Field Values

UTIL_PREFIX

private static final UTIL_PREFIX

Package prefix to be ignored for scanning.

See Also:

Constant Field Values

visitedClasses

private visitedClasses

List of visited classes (prevents cyclic scanning).

annotatedClasses

private annotatedClasses

List of annotated classes to be returned.

Constructor Detail

AnnotatedTypeElementScanner

public AnnotatedTypeElementScanner()

Creates new instance of AnnotatedClassScanner visitor.

Since:

UES6-00

Method Detail

visitType

public java.util.Set<javax.lang.model.element.TypeElement> visitType(javax.lang.model.element.TypeElement aElement,
java.lang.Class<? extends java.lang.annotation.Annotation> aAnnotation)

Visits type element.

Specified by:

visitType in interface javax.lang.model.element.ElementVisitor<java.util.Set<javax.lang.model.element.TypeElement>,java.lang.Class<? extends java.lang.annotation.Annotation>>

Overrides:

visitType in class javax.lang.model.util.ElementScanner6<java.util.Set<javax.lang.model.element.TypeElement>,java.lang.Class<? extends java.lang.annotation.Annotation>>

Parameters:

aElement - Visited element

aAnnotation - Annotation to be looked for

Returns:

List of classes annotated by given annotation

Since:

UES6-00

visitExecutable

public java.util.Set<javax.lang.model.element.TypeElement> visitExecutable(javax.lang.model.element.ExecutableElement aElement,
java.lang.Class<? extends java.lang.annotation.Annotation> aAnnotation)

Visits executable element.

Specified by:

visitExecutable in interface javax.lang.model.element.ElementVisitor<java.util.Set<javax.lang.model.element.TypeElement>,java.lang.Class<? extends java.lang.annotation.Annotation>>

Overrides:

visitExecutable in class javax.lang.model.util.ElementScanner6<java.util.Set<javax.lang.model.element.TypeElement>,java.lang.Class<? extends java.lang.annotation.Annotation>>

Parameters:

aElement - Visited element

aAnnotation - Annotation to be looked for

Returns:

List of classes annotated by given annotation

Since:

UES6-00

visitVariable

public java.util.Set<javax.lang.model.element.TypeElement> visitVariable(javax.lang.model.element.VariableElement aElement,
java.lang.Class<? extends java.lang.annotation.Annotation> aAnnotation)

Visits variable element.

Specified by:

visitVariable in interface javax.lang.model.element.ElementVisitor<java.util.Set<javax.lang.model.element.TypeElement>,java.lang.Class<? extends java.lang.annotation.Annotation>>

Overrides:

visitVariable in class javax.lang.model.util.ElementScanner6<java.util.Set<javax.lang.model.element.TypeElement>,java.lang.Class<? extends java.lang.annotation.Annotation>>

Parameters:

aElement - Visited element

aAnnotation - Annotation to be looked for

Returns:

List of classes annotated by given annotation

Since:

UES6-00

visitTypeMirror

private void visitTypeMirror(javax.lang.model.type.TypeMirror aType,
java.lang.Class<? extends java.lang.annotation.Annotation> aAnnotation)

Visits type mirror.

Parameters:

aType - Visited type

aAnnotation - Annotation to be looked for

Since:

UES6-00

isAnnotated

private boolean isAnnotated(javax.lang.model.element.TypeElement aElement,
java.lang.Class<? extends java.lang.annotation.Annotation> aAnnotation)

Checks if type element (class) is annotated with given annotation (either directly or using meta-annotation).

Parameters:

aElement - Element to be checked

aAnnotation - Annotation to be looked for

Returns:

True if element is annotated, else false

Since:

UES6-00