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

Class ASTLocalVariableDeclaration

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

All Implemented Interfaces:

Iterable<ASTVariableId>, GenericNode<JavaNode>, JjtreeNode<JavaNode>, Node, TextAvailableNode, Annotatable, ASTStatement, JavaNode, ModifierOwner, Reportable

public final class ASTLocalVariableDeclaration
extends AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
implements ASTStatement

Represents a local variable declaration. This is a statement, but the node is also used in for-loop initialisers and foreach statements.

This statement may define several variables, possibly of different types (see ASTVariableId.getTypeNode()). The nodes corresponding to the declared variables are accessible through getVarIds().

 LocalVariableDeclaration ::= LocalVarModifierList 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(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)
@Nullable FileLocation	getReportLocation()
@NonNull ASTCompilationUnit	getRoot()
@NonNull JSymbolTable	getSymbolTable()	Returns the symbol table for the program point represented by this node.
ASTType	getTypeNode()	Gets the type node for this variable declaration statement.
TypeSystem	getTypeSystem()	Returns the type system with which this node was created.
default NodeStream<ASTVariableId>	getVarIds()	Returns a stream of the variable ids declared by this node.
ModifierOwner.Visibility	getVisibility()	Returns the visibility corresponding to the effective modifiers.
String	getXPathNodeName()
protected void	insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
boolean	isFinal()
boolean	isTypeInferred()	If true, this local variable declaration represents a declaration, which makes use of local variable type inference, e.g.
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(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.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.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, 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 @Nullable 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)

getVisibility

public ModifierOwner.Visibility getVisibility()

Description copied from interface: ModifierOwner

Returns the visibility corresponding to the effective modifiers. Eg a public method will have visibility public, a local class will have visibility local. There cannot be any conflict with ModifierOwner.hasModifiers(JModifier, JModifier...)} on well-formed code (e.g. for any n, (n.getVisibility() == V_PROTECTED) == n.hasModifiers(PROTECTED))

TODO a public method of a private class can be considered to be private we could probably add another method later on that takes this into account

Specified by:

getVisibility in interface ModifierOwner

isTypeInferred

public boolean isTypeInferred()

If true, this local variable declaration represents a declaration, which makes use of local variable type inference, e.g. java10 "var". You can receive the inferred type via getTypeNode().getTypeMirror().

See Also:

ASTVariableId.isTypeInferred()

getTypeNode

public ASTType getTypeNode()

Gets the type node for this variable declaration statement. With Java10 and local variable type inference, there might be no type node at all.

Returns:

The type node or null

See Also:

isTypeInferred()

isFinal

public boolean isFinal()

getVarIds

public default 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 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