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

Class ASTFieldAccess

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.ASTFieldAccess

All Implemented Interfaces:

GenericNode<JavaNode>, JjtreeNode<JavaNode>, Node, TextAvailableNode, ASTAssignableExpr, ASTAssignableExpr.ASTNamedReferenceExpr, ASTExpression, ASTMemberValue, ASTPrimaryExpression, ASTSwitchArrowRHS, JavaNode, QualifiableExpression, TypeNode, Reportable

public final class ASTFieldAccess
extends AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
implements ASTAssignableExpr.ASTNamedReferenceExpr, QualifiableExpression

A field access expression.

 FieldAccess ::= Expression "." <IDENTIFIER>

 

Nested Class Summary

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

ASTAssignableExpr.AccessType, ASTAssignableExpr.ASTNamedReferenceExpr

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

ASTExpression.ConstResult

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)
protected @Nullable Object	buildConstValue()	Deprecated. Since 7.12.0.
protected void	enlargeLeft(JavaccToken child)
@NonNull ASTExpression.ConstResult	getConstFoldingResult()	Returns the result of constant folding on this expression.
String	getName()	Returns the name of the referenced variable.
int	getParenthesisDepth()	Returns the number of parenthesis levels around this expression.
@NonNull ASTExpression	getQualifier()	Returns the expression to the left of the "." if it exists.
@Nullable JFieldSymbol	getReferencedSym()	Returns the symbol referenced by this variable.
@NonNull ASTCompilationUnit	getRoot()
@Nullable JVariableSig.FieldSig	getSignature()	Returns the signature of the referenced variable.
@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.
String	getXPathNodeName()
protected void	insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
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, getImage, 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.ASTAssignableExpr

getAccessType

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

getConstFoldingResult, getConstValue, getConversionContext, getParenthesisDepth, isCompileTimeConstant, isExpression, isParenthesized

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.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.ast.Node

acceptVisitor, ancestors, children, compareLocation, descendants, firstChild, getAstInfo, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getImage, getIndexInParent, getLanguageVersion, getNumChildren, getReportLocation, 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

getQualifier

public @NonNull ASTExpression getQualifier()

Description copied from interface: QualifiableExpression

Returns the expression to the left of the "." if it exists. This may be a type expression, or an ambiguous name.

Specified by:

getQualifier in interface QualifiableExpression

getName

public String getName()

Description copied from interface: ASTAssignableExpr.ASTNamedReferenceExpr

Returns the name of the referenced variable.

Specified by:

getName in interface ASTAssignableExpr.ASTNamedReferenceExpr

getSignature

public @Nullable JVariableSig.FieldSig getSignature()

Description copied from interface: ASTAssignableExpr.ASTNamedReferenceExpr

Returns the signature of the referenced variable. This is relevant for fields, as they may be inherited from some parameterized supertype.

Specified by:

getSignature in interface ASTAssignableExpr.ASTNamedReferenceExpr

getReferencedSym

public @Nullable JFieldSymbol getReferencedSym()

Description copied from interface: ASTAssignableExpr.ASTNamedReferenceExpr

Returns the symbol referenced by this variable.

Specified by:

getReferencedSym in interface ASTAssignableExpr.ASTNamedReferenceExpr

acceptVisitor

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

getParenthesisDepth

public int getParenthesisDepth()

Description copied from interface: ASTExpression

Returns the number of parenthesis levels around this expression. If this method returns 0, then no parentheses are present.

E.g. the expression (a + b) is parsed as an AdditiveExpression whose parenthesisDepth is 1, and in ((a + b)) it's 2.

This is to avoid the parentheses interfering with analysis. Parentheses already influence parsing by breaking the natural precedence of operators. It would mostly hide false positives to make a ParenthesizedExpr node, because it would make semantically equivalent nodes have a very different representation.

On the other hand, when a rule explicitly cares about parentheses, then this attribute may be used to find out whether parentheses were mentioned, so no information is lost.

Specified by:

getParenthesisDepth in interface ASTExpression

getConstFoldingResult

public @NonNull ASTExpression.ConstResult getConstFoldingResult()

Description copied from interface: ASTExpression

Returns the result of constant folding on this expression. This may find a constant value for more than strict compile-time constants. See ASTExpression.ConstResult.

Specified by:

getConstFoldingResult in interface ASTExpression

buildConstValue

@Deprecated
protected @Nullable Object buildConstValue()

Deprecated.

Since 7.12.0. Kept for binary compatibility. This method should have been package-private from the start. Use ASTExpression.getConstValue() or ASTExpression.getConstFoldingResult() instead.

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>

enlargeLeft

protected void enlargeLeft(JavaccToken child)

Overrides:

enlargeLeft 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