cz.ues.platform.apt.visitor

Class XmlSeeAlsoTypeElementScanner

java.lang.Object

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

javax.lang.model.util.ElementScanner6<java.util.Set<javax.lang.model.element.TypeElement>,javax.annotation.processing.ProcessingEnvironment>

cz.ues.platform.apt.visitor.XmlSeeAlsoTypeElementScanner

All Implemented Interfaces:

javax.lang.model.element.ElementVisitor<java.util.Set<javax.lang.model.element.TypeElement>,javax.annotation.processing.ProcessingEnvironment>

public class XmlSeeAlsoTypeElementScanner
extends javax.lang.model.util.ElementScanner6<java.util.Set<javax.lang.model.element.TypeElement>,javax.annotation.processing.ProcessingEnvironment>

APT visitor used to scan whole tree of classes referenced from class on which is visitor initiated and also classes referenced via @XmlSeeAlso annotation. List of TypeElements representing matching referenced classes is returned as result.

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	LANG_PREFIX Package prefix to be ignored for scanning.
private java.util.Set<javax.lang.model.element.TypeElement>	referencedClasses List of referenced classes to be returned.
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
XmlSeeAlsoTypeElementScanner() Creates new instance of XmlSeeAlsoTypeElementScanner visitor.

Method Summary

Methods

Modifier and Type	Method and Description
private java.util.List<javax.lang.model.element.TypeElement>	getXmlSeeAlsoElements(javax.lang.model.element.TypeElement aElement, javax.annotation.processing.ProcessingEnvironment aEnv) Returns TypeElements referenced by XmlSeeAlso annotation on given type element.
java.util.Set<javax.lang.model.element.TypeElement>	visitExecutable(javax.lang.model.element.ExecutableElement aElement, javax.annotation.processing.ProcessingEnvironment aEnv) Visits executable element.
java.util.Set<javax.lang.model.element.TypeElement>	visitType(javax.lang.model.element.TypeElement aElement, javax.annotation.processing.ProcessingEnvironment aEnv) Visits type element.
private void	visitTypeMirror(javax.lang.model.type.TypeMirror aType, javax.annotation.processing.ProcessingEnvironment aEnv) Visits type mirror.
java.util.Set<javax.lang.model.element.TypeElement>	visitVariable(javax.lang.model.element.VariableElement aElement, javax.annotation.processing.ProcessingEnvironment aEnv) 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).

referencedClasses

private referencedClasses

List of referenced classes to be returned.

Constructor Detail

XmlSeeAlsoTypeElementScanner

public XmlSeeAlsoTypeElementScanner()

Creates new instance of XmlSeeAlsoTypeElementScanner visitor.

Since:

UES6-00

Method Detail

visitType

public java.util.Set<javax.lang.model.element.TypeElement> visitType(javax.lang.model.element.TypeElement aElement,
javax.annotation.processing.ProcessingEnvironment aEnv)

Visits type element.

Specified by:

visitType in interface javax.lang.model.element.ElementVisitor<java.util.Set<javax.lang.model.element.TypeElement>,javax.annotation.processing.ProcessingEnvironment>

Overrides:

visitType in class javax.lang.model.util.ElementScanner6<java.util.Set<javax.lang.model.element.TypeElement>,javax.annotation.processing.ProcessingEnvironment>

Parameters:

aElement - Visited element

aEnv - Processing environment

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,
javax.annotation.processing.ProcessingEnvironment aEnv)

Visits executable element.

Specified by:

visitExecutable in interface javax.lang.model.element.ElementVisitor<java.util.Set<javax.lang.model.element.TypeElement>,javax.annotation.processing.ProcessingEnvironment>

Overrides:

visitExecutable in class javax.lang.model.util.ElementScanner6<java.util.Set<javax.lang.model.element.TypeElement>,javax.annotation.processing.ProcessingEnvironment>

Parameters:

aElement - Visited element

aEnv - Processing environment

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,
javax.annotation.processing.ProcessingEnvironment aEnv)

Visits variable element.

Specified by:

visitVariable in interface javax.lang.model.element.ElementVisitor<java.util.Set<javax.lang.model.element.TypeElement>,javax.annotation.processing.ProcessingEnvironment>

Overrides:

visitVariable in class javax.lang.model.util.ElementScanner6<java.util.Set<javax.lang.model.element.TypeElement>,javax.annotation.processing.ProcessingEnvironment>

Parameters:

aElement - Visited element

aEnv - Processing environment

Returns:

List of classes annotated by given annotation

Since:

UES6-00

visitTypeMirror

private void visitTypeMirror(javax.lang.model.type.TypeMirror aType,
javax.annotation.processing.ProcessingEnvironment aEnv)

Visits type mirror.

Parameters:

aType - Visited type

aEnv - Processing environment

Since:

UES6-00

getXmlSeeAlsoElements

private java.util.List<javax.lang.model.element.TypeElement> getXmlSeeAlsoElements(javax.lang.model.element.TypeElement aElement,
javax.annotation.processing.ProcessingEnvironment aEnv)

Returns TypeElements referenced by XmlSeeAlso annotation on given type element. If annotation is not present, emtpy list is returned.

Parameters:

aElement - Element to be checked

aEnv - Processing environment

Returns:

List of referenced type elements

Since:

UES6-00