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

Class ASTPackageDeclaration

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

All Implemented Interfaces:

Node, Annotatable, JavaNode, ScopedNode

public class ASTPackageDeclaration
extends AbstractJavaNode

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
ASTPackageDeclaration(int id)	Deprecated.
ASTPackageDeclaration(JavaParser p, int id)	Deprecated.

Method Summary

Modifier and Type	Method	Description
ASTAnnotation	getAnnotation(String binaryName)	Returns a specific annotation on this node, or null if absent.
List<ASTAnnotation>	getDeclaredAnnotations()	Get all annotations present on this node.
String	getName()	Returns the name of the package.
String	getPackageNameImage()	Deprecated. Use getName()
boolean	isAnnotationPresent(String binaryName)	Checks whether the annotation is present on this node.
boolean	isAnyAnnotationPresent(Collection<String> binaryNames)	Checks whether any annotation is present on this node.
Object	jjtAccept(JavaParserVisitor visitor, Object data)	Calls back the visitor's visit method corresponding to the runtime type of this Node.

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

ASTPackageDeclaration

@InternalApi
@Deprecated
public ASTPackageDeclaration(int id)

Deprecated.

ASTPackageDeclaration

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

Deprecated.

Method Detail

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

getPackageNameImage

@Deprecated
@DeprecatedAttribute(replaceWith="@Name")
public String getPackageNameImage()

Deprecated.

Use getName()

getName

public String getName()

Returns the name of the package.

Since:

6.30.0

getDeclaredAnnotations

public List<ASTAnnotation> getDeclaredAnnotations()

Description copied from interface: Annotatable

Get all annotations present on this node.

Specified by:

getDeclaredAnnotations in interface Annotatable

Returns:

all annotations present on this node.

getAnnotation

public ASTAnnotation getAnnotation(String binaryName)

Description copied from interface: Annotatable

Returns a specific annotation on this node, or null if absent.

Specified by:

getAnnotation in interface Annotatable

Parameters:

binaryName - Binary name of the annotation type. Note: for now, canonical names are tolerated, this may be changed in PMD 7.

isAnnotationPresent

public boolean isAnnotationPresent(String binaryName)

Description copied from interface: Annotatable

Checks whether the annotation is present on this node.

Specified by:

isAnnotationPresent in interface Annotatable

Parameters:

binaryName - Binary name of the annotation type. Note: for now, canonical names are tolerated, this may be changed in PMD 7.

Returns:

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

isAnyAnnotationPresent

public boolean isAnyAnnotationPresent(Collection<String> binaryNames)

Description copied from interface: Annotatable

Checks whether any annotation is present on this node.

Specified by:

isAnyAnnotationPresent in interface Annotatable

Parameters:

binaryNames - Collection that contains binary names of annotations. Note: for now, canonical names are tolerated, this may be changed in PMD 7.

Returns:

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