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

Class ASTLocalVariableDeclaration

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      ASTAnnotation getAnnotation​(java.lang.String annotQualifiedName)
      Get specific annotaion on this node.
      int getArrayDepth()
      Deprecated.
      java.util.List<ASTAnnotation> getDeclaredAnnotations()
      Get all annotations present on this node.
      ASTType getTypeNode()
      Gets the type node for this variable declaration statement.
      java.lang.String getVariableName()
      Deprecated.
      LocalVariableDeclaration may declare several variables, so this is not exhaustive Iterate on the VariableDeclaratorIds instead
      boolean hasSuppressWarningsAnnotationFor​(net.sourceforge.pmd.Rule rule)  
      boolean isAnnotationPresent​(java.lang.String annotQualifiedName)
      Checks whether the annotation is present on this node.
      boolean isAnyAnnotationPresent​(java.util.Collection<java.lang.String> annotQualifiedNames)
      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.
      java.util.Iterator<ASTVariableDeclaratorId> iterator()
      Returns an iterator over the ids of the variables declared in this statement.
      java.lang.Object jjtAccept​(JavaParserVisitor visitor, java.lang.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.ast.AbstractNode

        appendElement, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getNthParent, getParentsOfType, getUserData, 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.ast.Node

        findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getNthParent, getParentsOfType, getUserData, 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 java.lang.Object jjtAccept​(JavaParserVisitor visitor,
                                  java.lang.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

      • isArray

        @Deprecated
public boolean isArray()
        Deprecated.
        Specified by:
        isArray 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
public java.lang.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 VariableDeclartorId 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 java.util.Iterator<ASTVariableDeclaratorId> iterator()
        Returns an iterator over the ids of the variables declared in this statement.
        Specified by:
        iterator in interface java.lang.Iterable<ASTVariableDeclaratorId>

      • getDeclaredAnnotations

        public java.util.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.

      • getAnnotation

        public ASTAnnotation getAnnotation​(java.lang.String annotQualifiedName)
        Description copied from interface: Annotatable
        Get specific annotaion on this node.
        Specified by:
        getAnnotation in interface Annotatable
        Parameters:
        annotQualifiedName - qulified name of the annotation.
        Returns:
        ASTAnnotaion node if the annotation is present on this node, else null

      • isAnnotationPresent

        public boolean isAnnotationPresent​(java.lang.String annotQualifiedName)
        Description copied from interface: Annotatable
        Checks whether the annotation is present on this node.
        Specified by:
        isAnnotationPresent in interface Annotatable
        Parameters:
        annotQualifiedName - qulified name of the annotation.
        Returns:
        true if the annotation is present on this node, else false

      • isAnyAnnotationPresent

        public boolean isAnyAnnotationPresent​(java.util.Collection<java.lang.String> annotQualifiedNames)
        Description copied from interface: Annotatable
        Checks whether any annotation is present on this node.
        Specified by:
        isAnyAnnotationPresent in interface Annotatable
        Parameters:
        annotQualifiedNames - collection that cotains qulified name of annotations.
        Returns:
        true if any annotation is present on this node, else false