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

Class ASTLocalVariableDeclaration

java.lang.Object

net.sourceforge.pmd.lang.ast.AbstractNode

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

net.sourceforge.pmd.lang.java.ast.AbstractJavaNode

net.sourceforge.pmd.lang.java.ast.AbstractJavaAccessNode

net.sourceforge.pmd.lang.java.ast.ASTLocalVariableDeclaration

All Implemented Interfaces:

Iterable<ASTVariableDeclaratorId>, Node, AccessNode, Annotatable, CanSuppressWarnings, Dimensionable, JavaNode, ScopedNode

public class ASTLocalVariableDeclaration
extends AbstractJavaAccessNode
implements Dimensionable, CanSuppressWarnings, Iterable<ASTVariableDeclaratorId>

Represents a local variable declaration. This is a block 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 ASTVariableDeclaratorId.getType()). The nodes corresponding to the declared variables are accessible through iterator().

 LocalVariableDeclaration ::= ( "final" | Annotation )* Type VariableDeclarator ( "," VariableDeclarator )*

 

Field Summary

Fields inherited from class net.sourceforge.pmd.lang.java.ast.AbstractJavaNode

parser

Fields inherited from class net.sourceforge.pmd.lang.ast.AbstractNode

beginColumn, beginLine, childIndex, children, endColumn, endLine, firstToken, id, lastToken, parent

Fields inherited from interface net.sourceforge.pmd.lang.java.ast.AccessNode

ABSTRACT, DEFAULT, FINAL, NATIVE, NON_SEALED, PRIVATE, PROTECTED, PUBLIC, SEALED, STATIC, STRICTFP, SYNCHRONIZED, TRANSIENT, VOLATILE

Constructor Summary

Constructors

Constructor	Description
ASTLocalVariableDeclaration(int id)	Deprecated.
ASTLocalVariableDeclaration(JavaParser p, int id)	Deprecated.

Method Summary

Modifier and Type	Method	Description
ASTAnnotation	getAnnotation(String binaryName)	Returns a specific annotation on this node, or null if absent.
int	getArrayDepth()	Deprecated.
List<ASTAnnotation>	getDeclaredAnnotations()	Get all annotations present on this node.
ASTType	getTypeNode()	Gets the type node for this variable declaration statement.
String	getVariableName()	Deprecated. LocalVariableDeclaration may declare several variables, so this is not exhaustive Iterate on the VariableDeclaratorIds instead
boolean	hasSuppressWarningsAnnotationFor(Rule rule)
boolean	isAnnotationPresent(String binaryName)	Checks whether the annotation is present on this node.
boolean	isAnyAnnotationPresent(Collection<String> binaryNames)	Checks whether any annotation is present on this node.
boolean	isArray()	Deprecated.
boolean	isTypeInferred()	If true, this local variable declaration represents a declaration, which makes use of local variable type inference, e.g.
Iterator<ASTVariableDeclaratorId>	iterator()	Returns an iterator over the ids of the variables declared in this statement.
Object	jjtAccept(JavaParserVisitor visitor, Object data)	Calls back the visitor's visit method corresponding to the runtime type of this Node.

Methods inherited from class net.sourceforge.pmd.lang.java.ast.AbstractJavaAccessNode

getModifiers, isAbstract, isDefault, isFinal, isNative, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile, setAbstract, setDefault, setFinal, setModifiers, setNative, setPrivate, setProtected, setPublic, setStatic, setStrictfp, setSynchronized, setTransient, setVolatile

Methods inherited from class net.sourceforge.pmd.lang.java.ast.AbstractJavaNode

childrenAccept, comment, comment, getRoot, getScope, getXPathNodeName, jjtClose, jjtOpen, setScope

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

children, getChild, getParent

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

appendElement, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getIndexInParent, getNthParent, getNumChildren, getParentsOfType, getUserData, getUserMap, getXPathAttributesIterator, hasDecendantOfAnyType, hasDescendantMatchingXPath, hasDescendantOfAnyType, hasDescendantOfType, hasImageEqualTo, isFindBoundary, isSingleLine, jjtAddChild, jjtGetChild, jjtGetChildIndex, jjtGetFirstToken, jjtGetId, jjtGetLastToken, jjtGetNumChildren, jjtGetParent, jjtSetChildIndex, jjtSetFirstToken, jjtSetLastToken, jjtSetParent, remove, removeChildAtIndex, setDataFlowNode, setImage, setUserData, testingOnlySetBeginColumn, testingOnlySetBeginLine, testingOnlySetEndColumn, testingOnlySetEndLine, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

children, childrenAccept, getChild, getParent, getRoot, setScope

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

findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getIndexInParent, getNthParent, getNumChildren, getParentsOfType, getUserData, getUserMap, getXPathAttributesIterator, getXPathNodeName, hasDescendantMatchingXPath, hasDescendantOfType, hasImageEqualTo, isFindBoundary, jjtAddChild, jjtClose, jjtGetChild, jjtGetChildIndex, jjtGetId, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetChildIndex, jjtSetParent, remove, removeChildAtIndex, setDataFlowNode, setImage, setUserData

Methods inherited from interface net.sourceforge.pmd.lang.symboltable.ScopedNode

getScope

Constructor Detail

ASTLocalVariableDeclaration

@InternalApi
@Deprecated
public ASTLocalVariableDeclaration(int id)

Deprecated.

ASTLocalVariableDeclaration

@InternalApi
@Deprecated
public ASTLocalVariableDeclaration(JavaParser p,
                                   int id)

Deprecated.

Method Detail

jjtAccept

public Object jjtAccept(JavaParserVisitor visitor,
                        Object data)

Description copied from interface: JavaNode

Calls back the visitor's visit method corresponding to the runtime type of this Node.

Specified by:

jjtAccept in interface JavaNode

Overrides:

jjtAccept in class AbstractJavaNode

Parameters:

visitor - Visitor to dispatch

data - Visit data

getDeclaredAnnotations

public List<ASTAnnotation> getDeclaredAnnotations()

Description copied from interface: Annotatable

Get all annotations present on this node.

Specified by:

getDeclaredAnnotations in interface Annotatable

Returns:

all annotations present on this node.

hasSuppressWarningsAnnotationFor

public boolean hasSuppressWarningsAnnotationFor(Rule rule)

Specified by:

hasSuppressWarningsAnnotationFor in interface CanSuppressWarnings

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 AbstractJavaTypeNode.getType().

See Also:

ASTVariableDeclaratorId.isTypeInferred()

isArray

@Deprecated
public boolean isArray()

Deprecated.

Specified by:

isArray in interface Dimensionable

getArrayDepth

@Deprecated
public int getArrayDepth()

Deprecated.

Specified by:

getArrayDepth in interface Dimensionable

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()

getVariableName

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

Deprecated.

LocalVariableDeclaration may declare several variables, so this is not exhaustive Iterate on the VariableDeclaratorIds instead

Gets the variable name of this declaration. This method searches the first VariableDeclaratorId node and returns it's image or null if the child node is not found.

Returns:

a String representing the name of the variable

iterator

public Iterator<ASTVariableDeclaratorId> iterator()

Returns an iterator over the ids of the variables declared in this statement.

Specified by:

iterator in interface Iterable<ASTVariableDeclaratorId>

getAnnotation

public ASTAnnotation getAnnotation(String binaryName)

Description copied from interface: Annotatable

Returns a specific annotation on this node, or null if absent.

Specified by:

getAnnotation in interface Annotatable

Parameters:

binaryName - Binary name of the annotation type. Note: for now, canonical names are tolerated, this may be changed in PMD 7.

isAnnotationPresent

public boolean isAnnotationPresent(String binaryName)

Description copied from interface: Annotatable

Checks whether the annotation is present on this node.

Specified by:

isAnnotationPresent in interface Annotatable

Parameters:

binaryName - Binary name of the annotation type. Note: for now, canonical names are tolerated, this may be changed in PMD 7.

Returns:

true if the annotation is present on this node, else false

isAnyAnnotationPresent

public boolean isAnyAnnotationPresent(Collection<String> binaryNames)

Description copied from interface: Annotatable

Checks whether any annotation is present on this node.

Specified by:

isAnyAnnotationPresent in interface Annotatable

Parameters:

binaryNames - Collection that contains binary names of annotations. Note: for now, canonical names are tolerated, this may be changed in PMD 7.

Returns:

true if any annotation is present on this node, else false