oracle.javatools.parser.java.v2.model

Interface JavaElement

All Superinterfaces:

Element

All Known Subinterfaces:

CompiledAccessExpression, CompiledDocReference, CompiledExpression, CompiledImport, CompiledInvokeExpression, CompiledSelfVariable, CompiledStatementLabel, CompiledTmpVariable, JavaAnnotation, JavaClass, JavaField, JavaFile, JavaHasAnnotations, JavaHasName, JavaHasType, JavaHasVersion, JavaIsGeneric, JavaLocalVariable, JavaMember, JavaMethod, JavaModule, JavaModuleExports, JavaModuleOpens, JavaModuleProvides, JavaModuleRequires, JavaModuleUses, JavaPackage, JavaType, JavaTypeVariable, JavaVariable, JavaWildcardType, SourceAnnotation, SourceAnnotationExpression, SourceArrayAccessExpression, SourceAssignmentExpression, SourceCatchParameter, SourceClass, SourceClassInitializer, SourceDereferenceExpression, SourceDocReference, SourceDocTagName, SourceDotExpression, SourceEnumConstant, SourceErrorExpression, SourceExpression, SourceFieldDeclaration, SourceFieldVariable, SourceFile, SourceFormalParameter, SourceImport, SourceInfixExpression, SourceIntersectionTypeExpression, SourceInvokeExpression, SourceLambdaExpression, SourceLambdaParameter, SourceListExpression, SourceLiteralExpression, SourceLocalVariable, SourceMember, SourceMemberVariable, SourceMethod, SourceMethodCallExpression, SourceMethodReferenceExpression, SourceModule, SourceModuleExports, SourceModuleOpens, SourceModuleProvides, SourceModuleRequires, SourceModuleUses, SourceName, SourceNewArrayExpression, SourceNewClassExpression, SourceOperatorExpression, SourceQuestionExpression, SourceSimpleNameExpression, SourceStatementLabel, SourceTypeArgument, SourceTypecastExpression, SourceTypeExpression, SourceTypeParameter, SourceTypeReference, SourceUnaryExpression, SourceVariable, SourceWrapperExpression

All Known Implementing Classes:

AbstractAnnotation, AbstractClass, AbstractElement, AbstractField, AbstractMethod, AbstractPackage, AbstractType, AbstractVariable, BaseFileProvider.BaseClass, BaseFileProvider.BasePackage, BaseFileProvider.ModuleBaseClass, CastedMethod, oracle.javatools.parser.java.v2.classfile.ClClass, IntersectionType, oracle.javatools.parser.java.v2.classfile.ModuleClass, ParameterizedClass, PrimitiveType, QuickComponent, QuickHasName, QuickHasType, QuickJavaClass, QuickLocalVariable, QuickMethod, SignatureHasType, Value, WrapperClass, WrapperField, WrapperLocalVariable, WrapperMethod, WrapperPackage

public interface JavaElement
extends Element

CompiledObject is the compiled representation of a syntactic (aka symbolic) java element.

Field Summary

Fields

Modifier and Type	Field and Description
static JavaElement[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
int	getElementKind()
JavaFile	getFile()
int	getModifiers()
JavaElement	getOwner() Finds the owner of this JavaElement, which is the closest named ancestor found, such as a JavaClass, JavaMethod, JavaField, etc.
SourceElement	getSourceElement()
boolean	isDeprecated()
boolean	isFinal()
boolean	isHidden()
default boolean	isMandated() Determine if an element is mandated, meaning it's implictly declared as mandated by the Java language spec.
boolean	isSourceElement() Determine if this IS a SourceElement in which case this JavaElement can be cast to a SourceElement.
boolean	isSynthetic()
java.lang.String	printCompiledInfo() Debugging function for printing out compiled information.

Field Detail

EMPTY_ARRAY

static final JavaElement[] EMPTY_ARRAY

Method Detail

getElementKind

int getElementKind()

Returns:

The type of JavaElement this is. Valid values are JavaConstants.ELEM_*.

getFile

JavaFile getFile()

Returns:

Returns the JavaFile that this element is contained in.

If a SourceFile is returned, then this element is declared in or otherwise comes in a SourceFile.

A non-null JavaFile may be returned that is not a SourceFile. For example, a JavaClass that came from a .class file definition will return such a JavaFile instance.

If null, then this element was created on-the-fly.

getOwner

JavaElement getOwner()

Finds the owner of this JavaElement, which is the closest named ancestor found, such as a JavaClass, JavaMethod, JavaField, etc.

Returns:

A JavaElement which might be null if no owner was found

isSourceElement

boolean isSourceElement()

Determine if this IS a SourceElement in which case this JavaElement can be cast to a SourceElement. Otherwise call getSourceElement() to see if the corresponding SourceElement can be found.

Returns:

True if this instance is a SourceElement itself. False otherwise.

getSourceElement

SourceElement getSourceElement()

Returns:

The corresponding source symbol to this element. Null if there is no corresponding source symbol or if the corresponding source symbol could not be found.

getModifiers

int getModifiers()

Returns:

The access modifiers on this element.

isFinal

boolean isFinal()

Returns:

True if element is modified with "final".

isSynthetic

boolean isSynthetic()

Returns:

True if element is synthetic.

isMandated

default boolean isMandated()

Determine if an element is mandated, meaning it's implictly declared as mandated by the Java language spec. Formal parameters can be mandated, but there are plans to allow other elements to be mandated as well.

Returns:

True if the element is mandated

isHidden

boolean isHidden()

Returns:

True if this is hidden (bug 2798659). False otherwise.

isDeprecated

boolean isDeprecated()

Returns:

True if this is deprecated. False otherwise.

printCompiledInfo

java.lang.String printCompiledInfo()

Debugging function for printing out compiled information.