Package net.sourceforge.pmd.lang.java.ast

Class ASTEnumConstant

java.lang.Object

net.sourceforge.pmd.lang.ast.impl.AbstractNode<B,N>

net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

net.sourceforge.pmd.lang.java.ast.ASTEnumConstant

All Implemented Interfaces:

GenericNode<JavaNode>, JjtreeNode<JavaNode>, Node, TextAvailableNode, Annotatable, ASTBodyDeclaration, InvocationNode, JavadocCommentOwner, JavaNode, MethodUsage, ModifierOwner, TypeNode, Reportable

public final class ASTEnumConstant
extends AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
implements Annotatable, InvocationNode, ModifierOwner, ASTBodyDeclaration, JavadocCommentOwner

Represents an enum constant declaration within an enum type declaration.

 EnumConstant ::= AnnotationList VariableId ArgumentList? AnonymousClassDeclaration?

 

Nested Class Summary

Nested classes/interfaces inherited from interface net.sourceforge.pmd.lang.java.ast.ModifierOwner

ModifierOwner.Visibility

Field Summary

Fields

Modifier and Type	Field	Description
protected JSymbolTable	symbolTable

Fields inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode

id

Fields inherited from interface net.sourceforge.pmd.lang.ast.Node

COORDS_COMPARATOR

Method Summary

Modifier and Type	Method	Description
<P,R> R	acceptVisitor(AstVisitor<? super P,? extends R> visitor, P data)
protected <P,R> R	acceptVisitor(JavaVisitor<? super P,? extends R> visitor, P data)
protected void	addChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
ASTAnonymousClassDeclaration	getAnonymousClass()	Returns the anonymous class declaration, or null if there is none.
@Nullable ASTArgumentList	getArguments()	Returns the node representing the list of arguments passed to the invocation.
@Nullable ASTTypeArguments	getExplicitTypeArguments()	Returns the explicit type arguments if they exist.
String	getImage()
String	getName()	Returns the name of the enum constant.
OverloadSelectionResult	getOverloadSelectionInfo()	Returns information about the overload selection for this call.
FileLocation	getReportLocation()
@NonNull ASTCompilationUnit	getRoot()
@NonNull JSymbolTable	getSymbolTable()	Returns the symbol table for the program point represented by this node.
@NonNull JTypeMirror	getTypeMirror()	Returns the compile-time type of this node.
@NonNull JTypeMirror	getTypeMirror(TypingContext context)
TypeSystem	getTypeSystem()	Returns the type system with which this node was created.
ASTVariableId	getVarId()
String	getXPathNodeName()
protected void	insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
boolean	isAnonymousClass()	Returns true if this enum constant defines a body, which is compiled like an anonymous class.
void	jjtClose()
protected void	removeChildAtIndex(int childIndex)
protected void	setChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
protected void	setFirstToken(JavaccToken token)
protected void	setImage(String image)
protected void	setLastToken(JavaccToken token)

Methods inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode

compareLocation, fitTokensToChildren, getFirstToken, getLastToken, getTextRegion, jjtOpen, toString

Methods inherited from class net.sourceforge.pmd.lang.ast.impl.AbstractNode

children, firstChild, getChild, getIndexInParent, getNumChildren, getParent, getUserMap, remove, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.Annotatable

getAnnotation, isAnnotationPresent, isAnnotationPresent, isAnyAnnotationPresent

Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.GenericNode

ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getChild, getFirstChild, getLastChild, getNextSibling, getParent, getPreviousSibling

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.InvocationNode

getMethodType

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.JavadocCommentOwner

getJavadocComment

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.JavaNode

getEnclosingType, getRoot, getSymbolTable, getTypeSystem

Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode

getFirstToken, getLastToken, tokens

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.MethodUsage

getMethodName

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.ModifierOwner

getDeclaredAnnotations, getEffectiveVisibility, getModifiers, getVisibility, hasExplicitModifiers, hasModifiers, hasVisibility

Methods inherited from interface net.sourceforge.pmd.lang.ast.Node

acceptVisitor, ancestors, children, compareLocation, descendants, firstChild, getAstInfo, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getIndexInParent, getLanguageVersion, getNumChildren, getTextDocument, getUserMap, getXPathAttributesIterator, getXPathNodeName, hasImageEqualTo, isFindBoundary

Methods inherited from interface net.sourceforge.pmd.lang.ast.TextAvailableNode

getOriginalText, getText, getTextRegion

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.TypeNode

getTypeMirror, getTypeMirror

Field Detail

symbolTable

protected JSymbolTable symbolTable

Method Detail

getReportLocation

public FileLocation getReportLocation()

Specified by:

getReportLocation in interface Node

Specified by:

getReportLocation in interface Reportable

acceptVisitor

protected <P,R> R acceptVisitor(JavaVisitor<? super P,? extends R> visitor,
                                      P data)

getVarId

public ASTVariableId getVarId()

getImage

public String getImage()

Specified by:

getImage in interface Node

Overrides:

getImage in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

getArguments

public @Nullable ASTArgumentList getArguments()

Description copied from interface: InvocationNode

Returns the node representing the list of arguments passed to the invocation. Can be null if this is an ASTEnumConstant.

Specified by:

getArguments in interface InvocationNode

getName

public String getName()

Returns the name of the enum constant.

isAnonymousClass

public boolean isAnonymousClass()

Returns true if this enum constant defines a body, which is compiled like an anonymous class.

getAnonymousClass

public ASTAnonymousClassDeclaration getAnonymousClass()

Returns the anonymous class declaration, or null if there is none.

getExplicitTypeArguments

public @Nullable ASTTypeArguments getExplicitTypeArguments()

Description copied from interface: InvocationNode

Returns the explicit type arguments if they exist.

Specified by:

getExplicitTypeArguments in interface InvocationNode

getOverloadSelectionInfo

public OverloadSelectionResult getOverloadSelectionInfo()

Description copied from interface: InvocationNode

Returns information about the overload selection for this call. Be aware, that selection might have failed (OverloadSelectionResult.isFailed()).

Specified by:

getOverloadSelectionInfo in interface InvocationNode

getTypeMirror

public @NonNull JTypeMirror getTypeMirror()

Description copied from interface: TypeNode

Returns the compile-time type of this node. For example, for a string literal, returns the type mirror for String, for a method call, returns the return type of the call, etc.

This method ignores conversions applied to the value of the node because of its context. For example, in 1 + "", the numeric literal will have type int, but it is converted to String by the surrounding concatenation expression. Similarly, in Collections.singletonList(1), the ASTNumericLiteral node has type int, but the type of the method formal is Integer, and boxing is applied at runtime. Possibly, an API will be added to expose this information.

Specified by:

getTypeMirror in interface TypeNode

Returns:

The type mirror. Never returns null; if the type is unresolved, returns TypeSystem.UNKNOWN.

getTypeMirror

public @NonNull JTypeMirror getTypeMirror(TypingContext context)

Specified by:

getTypeMirror in interface TypeNode

jjtClose

public void jjtClose()

Overrides:

jjtClose in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

acceptVisitor

public final <P,R> R acceptVisitor(AstVisitor<? super P,? extends R> visitor,
                                         P data)

Specified by:

acceptVisitor in interface Node

addChild

protected void addChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child,
                        int index)

Overrides:

addChild in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

insertChild

protected void insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child,
                           int index)

Overrides:

insertChild in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

removeChildAtIndex

protected void removeChildAtIndex(int childIndex)

Overrides:

removeChildAtIndex in class AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

setImage

protected void setImage(String image)

Overrides:

setImage in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

setFirstToken

protected void setFirstToken(JavaccToken token)

Overrides:

setFirstToken in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

setLastToken

protected void setLastToken(JavaccToken token)

Overrides:

setLastToken in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

setChild

protected void setChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child,
                        int index)

Overrides:

setChild in class AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

getSymbolTable

public @NonNull JSymbolTable getSymbolTable()

Description copied from interface: JavaNode

Returns the symbol table for the program point represented by this node.

Specified by:

getSymbolTable in interface JavaNode

getTypeSystem

public TypeSystem getTypeSystem()

Description copied from interface: JavaNode

Returns the type system with which this node was created. This is the object responsible for representing types in the compilation unit.

Specified by:

getTypeSystem in interface JavaNode

getRoot

public final @NonNull ASTCompilationUnit getRoot()

Specified by:

getRoot in interface JavaNode

Specified by:

getRoot in interface Node

getXPathNodeName

public final String getXPathNodeName()

Specified by:

getXPathNodeName in interface Node