Package com.sun.tools.javac.model

Class JavacElements

java.lang.Object

com.sun.tools.javac.model.JavacElements

All Implemented Interfaces:

Elements

public class JavacElements
extends Object
implements Elements

Utility methods for operating on program elements.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Nested Class Summary

Nested classes/interfaces inherited from interface javax.lang.model.util.Elements

Elements.Origin

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavacElements(Context context) Public for use only by JavacProcessingEnvironment

Method Summary

Modifier and Type	Method and Description
List<Attribute.Compound>	getAllAnnotationMirrors(Element e) Returns all annotations of an element, whether inherited or directly present.
FilteredMemberList	getAllMembers(TypeElement element)
Name	getBinaryName(TypeElement type)
String	getConstantExpression(Object value)
String	getDocComment(Element e)
Map<Symbol.MethodSymbol,Attribute>	getElementValuesWithDefaults(AnnotationMirror a)
Name	getName(CharSequence cs)
Symbol.PackageSymbol	getPackageElement(CharSequence name)
PackageElement	getPackageOf(Element e)
com.sun.tools.javac.model.JavacSourcePosition	getSourcePosition(Element e)
com.sun.tools.javac.model.JavacSourcePosition	getSourcePosition(Element e, AnnotationMirror a)
com.sun.tools.javac.model.JavacSourcePosition	getSourcePosition(Element e, AnnotationMirror a, AnnotationValue v)
JCTree	getTree(Element e) Returns the tree node corresponding to this element, or null if none can be found.
Pair<JCTree,JCTree.JCCompilationUnit>	getTreeAndTopLevel(Element e, AnnotationMirror a, AnnotationValue v) Returns the best approximation for the tree node and compilation unit corresponding to the given element, annotation and value.
Symbol.ClassSymbol	getTypeElement(CharSequence name)
boolean	hides(Element hiderEl, Element hideeEl)
static JavacElements	instance(Context context)
boolean	isDeprecated(Element e)
boolean	isFunctionalInterface(TypeElement element)
boolean	overrides(ExecutableElement riderEl, ExecutableElement rideeEl, TypeElement typeEl)
void	printElements(Writer w, Element... elements) Print a representation of the elements to the given writer in the specified order.
void	setContext(Context context) Use a new context.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.lang.model.util.Elements

getAllModuleElements, getAllPackageElements, getAllTypeElements, getModuleElement, getModuleOf, getOrigin, getOrigin, getOrigin, getPackageElement, getTypeElement, isBridge

Constructor Detail

JavacElements

protected JavacElements(Context context)

Public for use only by JavacProcessingEnvironment

Method Detail

instance

public static JavacElements instance(Context context)

setContext

public void setContext(Context context)

Use a new context. May be called from outside to update internal state for a new annotation-processing round.

getPackageElement

public Symbol.PackageSymbol getPackageElement(CharSequence name)

Specified by:

getPackageElement in interface Elements

getTypeElement

public Symbol.ClassSymbol getTypeElement(CharSequence name)

Specified by:

getTypeElement in interface Elements

getSourcePosition

public com.sun.tools.javac.model.JavacSourcePosition getSourcePosition(Element e)

getSourcePosition

public com.sun.tools.javac.model.JavacSourcePosition getSourcePosition(Element e,
                                                                       AnnotationMirror a)

getSourcePosition

public com.sun.tools.javac.model.JavacSourcePosition getSourcePosition(Element e,
                                                                       AnnotationMirror a,
                                                                       AnnotationValue v)

getTree

public JCTree getTree(Element e)

Returns the tree node corresponding to this element, or null if none can be found.

getDocComment

public String getDocComment(Element e)

Specified by:

getDocComment in interface Elements

getPackageOf

public PackageElement getPackageOf(Element e)

Specified by:

getPackageOf in interface Elements

isDeprecated

public boolean isDeprecated(Element e)

Specified by:

isDeprecated in interface Elements

getBinaryName

public Name getBinaryName(TypeElement type)

Specified by:

getBinaryName in interface Elements

getElementValuesWithDefaults

public Map<Symbol.MethodSymbol,Attribute> getElementValuesWithDefaults(AnnotationMirror a)

Specified by:

getElementValuesWithDefaults in interface Elements

getAllMembers

public FilteredMemberList getAllMembers(TypeElement element)

Specified by:

getAllMembers in interface Elements

getAllAnnotationMirrors

public List<Attribute.Compound> getAllAnnotationMirrors(Element e)

Returns all annotations of an element, whether inherited or directly present.

Specified by:

getAllAnnotationMirrors in interface Elements

Parameters:

e - the element being examined

Returns:

all annotations of the element

hides

public boolean hides(Element hiderEl,
                     Element hideeEl)

Specified by:

hides in interface Elements

overrides

public boolean overrides(ExecutableElement riderEl,
                         ExecutableElement rideeEl,
                         TypeElement typeEl)

Specified by:

overrides in interface Elements

getConstantExpression

public String getConstantExpression(Object value)

Specified by:

getConstantExpression in interface Elements

printElements

public void printElements(Writer w,
                          Element... elements)

Print a representation of the elements to the given writer in the specified order. The main purpose of this method is for diagnostics. The exact format of the output is not specified and is subject to change.

Specified by:

printElements in interface Elements

Parameters:

w - the writer to print the output to

elements - the elements to print

getName

public Name getName(CharSequence cs)

Specified by:

getName in interface Elements

isFunctionalInterface

public boolean isFunctionalInterface(TypeElement element)

Specified by:

isFunctionalInterface in interface Elements

getTreeAndTopLevel

public Pair<JCTree,JCTree.JCCompilationUnit> getTreeAndTopLevel(Element e,
                                                                AnnotationMirror a,
                                                                AnnotationValue v)

Returns the best approximation for the tree node and compilation unit corresponding to the given element, annotation and value. If the element is null, null is returned. If the annotation is null or cannot be found, the tree node and compilation unit for the element is returned. If the annotation value is null or cannot be found, the tree node and compilation unit for the annotation is returned.