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

Class ASTAnnotation

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

      • getFlatValue

        public 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"]

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

      • 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>

      • 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