net.sourceforge.pmd.lang.java.ast.ASTAnnotation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pmd-java Show documentation
There is a newer version: 7.7.0
/**
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.lang.java.ast;

import java.util.Iterator;

import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

import net.sourceforge.pmd.annotation.DeprecatedUntil700;
import net.sourceforge.pmd.lang.ast.NodeStream;
import net.sourceforge.pmd.lang.java.types.JClassType;

/**
 * Represents an annotation.
 *
 *  *
 * Annotation ::= "@" {@link ASTClassOrInterfaceType ClassName} {@link ASTAnnotationMemberList AnnotationMemberList}?
 *
 * 
 */
public final class ASTAnnotation extends AbstractJavaTypeNode implements TypeNode, ASTMemberValue, Iterable {

    ASTAnnotation(int id) {
        super(id);
    }


    /**
     * Returns the node that represents the name of the annotation.
     */
    public ASTClassOrInterfaceType getTypeNode() {
        return (ASTClassOrInterfaceType) getChild(0);
    }

    @Override
    public @NonNull JClassType getTypeMirror() {
        return (JClassType) super.getTypeMirror();
    }

    /**
     * Returns the name of the annotation as it is used,
     * eg {@code java.lang.Override} or {@code Override}.
     *
     * @deprecated Use {@link #getTypeMirror()} instead
     */
    @Deprecated
    @DeprecatedUntil700
    public String getAnnotationName() {
        return getTypeNode().getText().toString();
    }

    /**
     * Returns the simple name of the annotation.
     */
    public String getSimpleName() {
        return getTypeNode().getSimpleName();
    }


    /**
     * Returns the list of members, or null if there is none.
     */
    public @Nullable ASTAnnotationMemberList getMemberList() {
        return children().first(ASTAnnotationMemberList.class);
    }

    /**
     * Returns the stream of explicit members for this annotation.
     */
    public NodeStream getMembers() {
        return children(ASTAnnotationMemberList.class).children(ASTMemberValuePair.class);
    }


    @Override
    public Iterator iterator() {
        return children(ASTMemberValuePair.class).iterator();
    }

    /**
     * Return the expression values for the attribute with the given name.
     * This may flatten an array initializer. For example, for the attribute
     * named "value":
     * {@code
     * - @SuppressWarnings -> returns empty node stream
     * - @SuppressWarning("fallthrough") -> returns ["fallthrough"]
     * - @SuppressWarning(value={"fallthrough"}) -> returns ["fallthrough"]
     * - @SuppressWarning({"fallthrough", "rawtypes"}) -> returns ["fallthrough", "rawtypes"]
     * }
     */
    public NodeStream getFlatValue(String attrName) {
        return NodeStream.of(getAttribute(attrName))
                         .flatMap(v -> v instanceof ASTMemberValueArrayInitializer ? v.children(ASTMemberValue.class)
                                                                                   : NodeStream.of(v));
    }

    /**
     * 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":
     * {@code
     * - @SuppressWarnings -> returns null
     * - @SuppressWarning("fallthrough") -> returns "fallthrough"
     * - @SuppressWarning(value={"fallthrough"}) -> returns {"fallthrough"}
     * - @SuppressWarning({"fallthrough", "rawtypes"}) -> returns {"fallthrough", "rawtypes"}
     * }
     *
     * @param attrName Name of an attribute
     */
    public @Nullable ASTMemberValue getAttribute(String attrName) {
        return getMembers().filter(pair -> pair.getName().equals(attrName))
                           .map(ASTMemberValuePair::getValue)
                           .first();
    }


    @Override
    public  R acceptVisitor(JavaVisitor visitor, P data) {
        return visitor.visit(this, data);
    }

}