Class ASTAnnotation

    • 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <P,​R>
      R
      acceptVisitor​(net.sourceforge.pmd.lang.ast.AstVisitor<? super P,​? extends R> visitor, P data)  
      <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)  
      @Nullable ASTMemberValue getAttribute​(String attrName)
      Returns the value of the attribute with the given name, returns null if no such attribute was mentioned.
      net.sourceforge.pmd.lang.ast.NodeStream<ASTMemberValue> getFlatValue​(String attrName)
      Return the expression values for the attribute with the given name.
      net.sourceforge.pmd.lang.ast.NodeStream<ASTMemberValue> getFlatValues()
      Return expression values for all attributes.
      @Nullable ASTAnnotationMemberList getMemberList()
      Returns the list of members, or null if there is none.
      net.sourceforge.pmd.lang.ast.NodeStream<ASTMemberValuePair> getMembers()
      Returns the stream of explicit members for this annotation.
      @NonNull ASTCompilationUnit getRoot()  
      String getSimpleName()
      Returns the simple name of the annotation.
      @NonNull JSymbolTable getSymbolTable()
      Returns the symbol table for the program point represented by this node.
      @NonNull JClassType getTypeMirror()
      Returns the compile-time type of this node.
      @NonNull JTypeMirror getTypeMirror​(TypingContext context)  
      ASTClassType getTypeNode()
      Returns the node that represents the name of the annotation.
      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)  
      Iterator<ASTMemberValuePair> 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 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.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
    • Method Detail

      • getTypeNode

        public ASTClassType getTypeNode()
        Returns the node that represents the name of the annotation.
      • getTypeMirror

        public @NonNull JClassType 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.
      • getSimpleName

        public String getSimpleName()
        Returns the simple name of the annotation.
      • getMemberList

        public @Nullable ASTAnnotationMemberList getMemberList()
        Returns the list of members, or null if there is none.
      • getMembers

        public net.sourceforge.pmd.lang.ast.NodeStream<ASTMemberValuePair> getMembers()
        Returns the stream of explicit members for this annotation.
      • getFlatValue

        public net.sourceforge.pmd.lang.ast.NodeStream<ASTMemberValue> getFlatValue​(String attrName)
        Return the expression values for the attribute with the given name. This may flatten an array initializer. For example, for the attribute named "value":
        
         - @SuppressWarnings -> returns empty node stream
         - @SuppressWarning("fallthrough") -> returns ["fallthrough"]
         - @SuppressWarning(value={"fallthrough"}) -> returns ["fallthrough"]
         - @SuppressWarning({"fallthrough", "rawtypes"}) -> returns ["fallthrough", "rawtypes"]
         
      • getFlatValues

        public net.sourceforge.pmd.lang.ast.NodeStream<ASTMemberValue> getFlatValues()
        Return expression values for all attributes. This may flatten an array initializer. For example, for the attribute named "value":
        
         - @SuppressWarnings -> returns empty node stream
         - @SuppressWarning("fallthrough") -> returns ["fallthrough"]
         - @SuppressWarning(value={"fallthrough"}) -> returns ["fallthrough"]
         - @SuppressWarning({"fallthrough", "rawtypes"}) -> returns ["fallthrough", "rawtypes"]
         
      • getAttribute

        public @Nullable ASTMemberValue getAttribute​(String attrName)
        Returns the value of the attribute with the given name, returns null if no such attribute was mentioned. For example, for the attribute named "value":
        
         - @SuppressWarnings -> returns null
         - @SuppressWarning("fallthrough") -> returns "fallthrough"
         - @SuppressWarning(value={"fallthrough"}) -> returns {"fallthrough"}
         - @SuppressWarning({"fallthrough", "rawtypes"}) -> returns {"fallthrough", "rawtypes"}
         
        Parameters:
        attrName - Name of an attribute
      • acceptVisitor

        public <P,​R> R acceptVisitor​(JavaVisitor<? super P,​? extends R> visitor,
                                           P data)
      • 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