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

Class ASTAnnotation

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

net.sourceforge.pmd.lang.java.ast.ASTAnnotation

All Implemented Interfaces:

Node, JavaNode, TypeNode, ScopedNode

public class ASTAnnotation
extends AbstractJavaTypeNode

Represents an annotation. This node has three possible children, that correspond to specific syntactic variants.

 Annotation ::= NormalAnnotation
              | SingleMemberAnnotation
              | MarkerAnnotation

 

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getAnnotationName()	Returns the name of the annotation as it is used, eg java.lang.Override or Override.
Object	jjtAccept(JavaParserVisitor visitor, Object data)	Calls back the visitor's visit method corresponding to the runtime type of this Node.
boolean	suppresses(Rule rule)	Returns true if this annotation suppresses the given rule.

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

getType, getTypeDefinition, setType, setTypeDefinition

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

ASTAnnotation

@InternalApi
@Deprecated
public ASTAnnotation(int id)

Deprecated.

ASTAnnotation

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

Deprecated.

Method Detail

getAnnotationName

public String getAnnotationName()

Returns the name of the annotation as it is used, eg java.lang.Override or Override.

suppresses

public boolean suppresses(Rule rule)

Returns true if this annotation suppresses the given rule. The suppression annotation is SuppressWarnings. This method returns true if this annotation is a SuppressWarnings, and if the set of suppressed warnings (SuppressWarnings.value()) contains at least one of those:

• "PMD" (suppresses all rules);
• "PMD.rulename", where rulename is the name of the given rule;
• "all" (conventional value to suppress all warnings).

Additionally, the following values suppress a specific set of rules:

• "unused": suppresses rules like UnusedLocalVariable or UnusedPrivateField;
• "serial": suppresses BeanMembersShouldSerialize and MissingSerialVersionUID;

Parameters:

rule - The rule for which to check for suppression

Returns:

True if this annotation suppresses the given rule

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