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

Class ASTFieldDeclaration

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

All Implemented Interfaces:

Iterable<ASTVariableId>, net.sourceforge.pmd.lang.ast.impl.GenericNode<JavaNode>, net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode<JavaNode>, net.sourceforge.pmd.lang.ast.Node, net.sourceforge.pmd.lang.ast.TextAvailableNode, Annotatable, ASTBodyDeclaration, JavadocCommentOwner, JavaNode, ModifierOwner, net.sourceforge.pmd.reporting.Reportable

public final class ASTFieldDeclaration
extends net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
implements ASTBodyDeclaration, JavadocCommentOwner

Represents a field declaration in the body of a type declaration.

This declaration may define several variables, possibly of different types. The nodes corresponding to the declared variables are accessible through Iterable.iterator().

 FieldDeclaration ::= ModifierList Type VariableDeclarator ( "," VariableDeclarator )* ";"

 

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(net.sourceforge.pmd.lang.ast.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 void	enlargeLeft(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken child)
net.sourceforge.pmd.lang.document.FileLocation	getReportLocation()
@NonNull ASTCompilationUnit	getRoot()
@NonNull JSymbolTable	getSymbolTable()	Returns the symbol table for the program point represented by this node.
ASTType	getTypeNode()	Returns the type node at the beginning of this field declaration.
TypeSystem	getTypeSystem()	Returns the type system with which this node was created.
String	getVariableName()	Deprecated. FieldDeclaration may declare several variables, so this is not exhaustive Iterate on the VariableIds instead
default net.sourceforge.pmd.lang.ast.NodeStream<ASTVariableId>	getVarIds()	Returns a stream of the variable ids declared by this node.
String	getXPathNodeName()
protected void	insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
boolean	isStatic()	Returns true if this field is static.
default Iterator<ASTVariableId>	iterator()
void	jjtClose()
protected void	removeChildAtIndex(int childIndex)
protected void	setChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
protected void	setFirstToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)
protected void	setImage(String image)
protected void	setLastToken(net.sourceforge.pmd.lang.ast.impl.javacc.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.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 java.lang.Iterable

forEach, spliterator

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.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, getImage, getIndexInParent, getLanguageVersion, getNumChildren, getTextDocument, getUserMap, getXPathAttributesIterator, getXPathNodeName, hasImageEqualTo, isFindBoundary

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

getOriginalText, getText, getTextRegion

Field Detail

symbolTable

protected JSymbolTable symbolTable

Method Detail

getReportLocation

public net.sourceforge.pmd.lang.document.FileLocation getReportLocation()

Specified by:

getReportLocation in interface net.sourceforge.pmd.lang.ast.Node

Specified by:

getReportLocation in interface net.sourceforge.pmd.reporting.Reportable

acceptVisitor

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

getVariableName

@Deprecated
@DeprecatedAttribute(replaceWith="VariableId/@Name")
public String getVariableName()

Deprecated.

FieldDeclaration may declare several variables, so this is not exhaustive Iterate on the VariableIds instead

Gets the variable name of this field. This method searches the first VariableId node and returns its image or null if the child node is not found.

Returns:

a String representing the name of the variable

getTypeNode

public ASTType getTypeNode()

Returns the type node at the beginning of this field declaration. The type of this node is not necessarily the type of the variables, see ASTVariableId.getTypeNode().

isStatic

public boolean isStatic()

Returns true if this field is static.

getVarIds

public default net.sourceforge.pmd.lang.ast.NodeStream<ASTVariableId> getVarIds()

Returns a stream of the variable ids declared by this node.

iterator

public default Iterator<ASTVariableId> iterator()

Specified by:

iterator in interface Iterable<ASTVariableId>

jjtClose

public void jjtClose()

Overrides:

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

acceptVisitor

public final <P,R> R acceptVisitor(net.sourceforge.pmd.lang.ast.AstVisitor<? super P,? extends R> visitor,
                                         P data)

Specified by:

acceptVisitor in interface net.sourceforge.pmd.lang.ast.Node

addChild

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

Overrides:

addChild in class net.sourceforge.pmd.lang.ast.impl.javacc.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 net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

removeChildAtIndex

protected void removeChildAtIndex(int childIndex)

Overrides:

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

setImage

protected void setImage(String image)

Overrides:

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

setFirstToken

protected void setFirstToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)

Overrides:

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

setLastToken

protected void setLastToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)

Overrides:

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

enlargeLeft

protected void enlargeLeft(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken child)

Overrides:

enlargeLeft in class net.sourceforge.pmd.lang.ast.impl.javacc.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 net.sourceforge.pmd.lang.ast.impl.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 net.sourceforge.pmd.lang.ast.Node

getXPathNodeName

public final String getXPathNodeName()

Specified by:

getXPathNodeName in interface net.sourceforge.pmd.lang.ast.Node