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

Interface Annotatable

All Superinterfaces:

JavaNode, net.sourceforge.pmd.lang.ast.Node, net.sourceforge.pmd.lang.symboltable.ScopedNode

All Known Implementing Classes:

AbstractAnyTypeDeclaration, AbstractJavaAccessNode, AbstractJavaAccessTypeNode, AbstractMethodLikeNode, AbstractMethodOrConstructorDeclaration, ASTAnnotationMethodDeclaration, ASTAnnotationTypeDeclaration, ASTClassOrInterfaceDeclaration, ASTConstructorDeclaration, ASTEnumDeclaration, ASTFieldDeclaration, ASTFormalParameter, ASTLambdaExpression, ASTLocalVariableDeclaration, ASTMethodDeclaration, ASTPackageDeclaration, ASTResource

public interface Annotatable
extends JavaNode

The interface use to mark nodes that can be annotated.

Method Summary

Modifier and Type	Method	Description
ASTAnnotation	getAnnotation(java.lang.String annotQualifiedName)	Get specific annotaion on this node.
java.util.List<ASTAnnotation>	getDeclaredAnnotations()	Get all annotations present on this node.
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.

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.JavaNode

childrenAccept, getScope, jjtAccept, setScope

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, getXPathNodeName, hasDescendantMatchingXPath, hasDescendantOfType, hasImageEqualTo, isFindBoundary, jjtAddChild, jjtClose, jjtGetChild, jjtGetChildIndex, jjtGetId, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetChildIndex, jjtSetParent, remove, removeChildAtIndex, setDataFlowNode, setImage, setUserData

Method Detail

getDeclaredAnnotations

java.util.List<ASTAnnotation> getDeclaredAnnotations()

Get all annotations present on this node.

Returns:

all annotations present on this node.

getAnnotation

ASTAnnotation getAnnotation(java.lang.String annotQualifiedName)

Get specific annotaion on this node.

Parameters:

annotQualifiedName - qulified name of the annotation.

Returns:

ASTAnnotaion node if the annotation is present on this node, else null

isAnyAnnotationPresent

boolean isAnyAnnotationPresent(java.util.Collection<java.lang.String> annotQualifiedNames)

Checks whether any annotation is present on this node.

Parameters:

annotQualifiedNames - collection that cotains qulified name of annotations.

Returns:

true if any annotation is present on this node, else false

isAnnotationPresent

boolean isAnnotationPresent(java.lang.String annotQualifiedName)

Checks whether the annotation is present on this node.

Parameters:

annotQualifiedName - qulified name of the annotation.

Returns:

true if the annotation is present on this node, else false