cz.ues.platform.apt.visitor

Class EnumerationScanner

java.lang.Object

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

javax.lang.model.util.ElementScanner6<java.util.Set<java.lang.String>,javax.lang.model.type.NullType>

cz.ues.platform.apt.visitor.EnumerationScanner

All Implemented Interfaces:

javax.lang.model.element.ElementVisitor<java.util.Set<java.lang.String>,javax.lang.model.type.NullType>

public class EnumerationScanner
extends javax.lang.model.util.ElementScanner6<java.util.Set<java.lang.String>,javax.lang.model.type.NullType>

APT visitor used to scan whole tree of classes referenced from class on which is visitor initiated. List of Enumerations is returned as result.

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ENUM_CLASS Name of enumeration class.
private java.util.Set<java.lang.String>	enumerations List of enumerations to be returned.
private static java.lang.String	JAVA_PREFIX Package prefix to be ignored for returned enumerations.
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<java.lang.String>	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
EnumerationScanner() Creates new instance of EnumerationScanner visitor.

Method Summary

Methods

Modifier and Type	Method and Description
private boolean	isEnumeration(javax.lang.model.element.TypeElement aElement) Checks if type element (class) is enumeration.
java.util.Set<java.lang.String>	visitExecutable(javax.lang.model.element.ExecutableElement aElement, javax.lang.model.type.NullType aParam) Visits executable element.
java.util.Set<java.lang.String>	visitType(javax.lang.model.element.TypeElement aElement, javax.lang.model.type.NullType aParam) Visits type element.
private void	visitTypeMirror(javax.lang.model.type.TypeMirror aType, javax.lang.model.type.NullType aParam) Visits type mirror.
java.util.Set<java.lang.String>	visitVariable(javax.lang.model.element.VariableElement aElement, javax.lang.model.type.NullType aParam) 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

JAVA_PREFIX

private static final JAVA_PREFIX

Package prefix to be ignored for returned enumerations.

See Also:

Constant Field Values

ENUM_CLASS

private static final ENUM_CLASS

Name of enumeration class.

visitedClasses

private visitedClasses

List of visited classes (prevents cyclic scanning).

enumerations

private enumerations

List of enumerations to be returned.

Constructor Detail

EnumerationScanner

public EnumerationScanner()

Creates new instance of EnumerationScanner visitor.

Since:

UES6-00

Method Detail

visitType

public java.util.Set<java.lang.String> visitType(javax.lang.model.element.TypeElement aElement,
javax.lang.model.type.NullType aParam)

Visits type element.

Specified by:

visitType in interface javax.lang.model.element.ElementVisitor<java.util.Set<java.lang.String>,javax.lang.model.type.NullType>

Overrides:

visitType in class javax.lang.model.util.ElementScanner6<java.util.Set<java.lang.String>,javax.lang.model.type.NullType>

Parameters:

aElement - Visited element

aParam - Unused parameter

Returns:

List of enumerations

Since:

UES6-00

visitExecutable

public java.util.Set<java.lang.String> visitExecutable(javax.lang.model.element.ExecutableElement aElement,
javax.lang.model.type.NullType aParam)

Visits executable element.

Specified by:

visitExecutable in interface javax.lang.model.element.ElementVisitor<java.util.Set<java.lang.String>,javax.lang.model.type.NullType>

Overrides:

visitExecutable in class javax.lang.model.util.ElementScanner6<java.util.Set<java.lang.String>,javax.lang.model.type.NullType>

Parameters:

aElement - Visited element

aParam - Unused parameter

Returns:

List of enumerations

Since:

UES6-00

visitVariable

public java.util.Set<java.lang.String> visitVariable(javax.lang.model.element.VariableElement aElement,
javax.lang.model.type.NullType aParam)

Visits variable element.

Specified by:

visitVariable in interface javax.lang.model.element.ElementVisitor<java.util.Set<java.lang.String>,javax.lang.model.type.NullType>

Overrides:

visitVariable in class javax.lang.model.util.ElementScanner6<java.util.Set<java.lang.String>,javax.lang.model.type.NullType>

Parameters:

aElement - Visited element

aParam - Unused parameter

Returns:

List of enumerations

Since:

UES6-00

visitTypeMirror

private void visitTypeMirror(javax.lang.model.type.TypeMirror aType,
javax.lang.model.type.NullType aParam)

Visits type mirror.

Parameters:

aType - Visited type

aParam - Unused parameter

Since:

UES6-00

isEnumeration

private boolean isEnumeration(javax.lang.model.element.TypeElement aElement)

Checks if type element (class) is enumeration.

Parameters:

aElement - Element to be checked

Returns:

True if element enumeration, else false

Since:

UES6-00