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

Class AbstractAnyTypeDeclaration

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

net.sourceforge.pmd.lang.java.ast.AbstractJavaAccessTypeNode

net.sourceforge.pmd.lang.java.ast.AbstractAnyTypeDeclaration

All Implemented Interfaces:

Node, QualifiableNode, AccessNode, Annotatable, ASTAnyTypeDeclaration, JavaNode, JavaQualifiableNode, TypeNode, ScopedNode

Direct Known Subclasses:

ASTAnnotationTypeDeclaration, ASTClassOrInterfaceDeclaration, ASTEnumDeclaration, ASTRecordDeclaration

@Deprecated
@InternalApi
public abstract class AbstractAnyTypeDeclaration
extends AbstractJavaAccessTypeNode
implements ASTAnyTypeDeclaration

Deprecated.

Abstract class for type declarations nodes.

Nested Class Summary

Nested classes/interfaces inherited from interface net.sourceforge.pmd.lang.java.ast.ASTAnyTypeDeclaration

ASTAnyTypeDeclaration.TypeKind

Field Summary

Fields inherited from class net.sourceforge.pmd.lang.java.ast.AbstractJavaAccessTypeNode

typeDefinition

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

Fields inherited from interface net.sourceforge.pmd.lang.java.ast.AccessNode

ABSTRACT, DEFAULT, FINAL, NATIVE, NON_SEALED, PRIVATE, PROTECTED, PUBLIC, SEALED, STATIC, STRICTFP, SYNCHRONIZED, TRANSIENT, VOLATILE

Method Summary

Modifier and Type	Method	Description
boolean	enclosingTypeIsA(ASTAnyTypeDeclaration.TypeKind... kinds)	Deprecated. Returns true if the enclosing type of this type declaration is any of the given kinds.
ASTAnnotation	getAnnotation(String binaryName)	Returns a specific annotation on this node, or null if absent.
String	getBinaryName()	Deprecated. Returns the binary name of this type declaration.
List<ASTAnnotation>	getDeclaredAnnotations()	Get all annotations present on this node.
ASTAnyTypeDeclaration	getEnclosingTypeDeclaration()	Deprecated. Returns the enclosing type of this type, if it is nested.
String	getImage()	Deprecated. Use getSimpleName()
JavaTypeQualifiedName	getQualifiedName()	Deprecated. Returns a qualified name for this node.
ASTRecordComponentList	getRecordComponents()	Deprecated. Returns the record component list, or null if this is not a record declaration.
String	getSimpleName()	Deprecated. Returns the simple name of this type declaration.
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.
boolean	isNested()	Deprecated. Returns true if this type declaration is nested inside an interface, class or annotation.
void	setQualifiedName(JavaTypeQualifiedName qualifiedName)	Deprecated.

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

getType, getTypeDefinition, setType, setTypeDefinition

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

getModifiers, isAbstract, isDefault, isFinal, isNative, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile, setAbstract, setDefault, setFinal, setModifiers, setNative, setPrivate, setProtected, setPublic, setStatic, setStrictfp, setSynchronized, setTransient, setVolatile

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

childrenAccept, comment, comment, getRoot, getScope, getXPathNodeName, jjtAccept, 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, 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.AccessNode

getModifiers, isAbstract, isDefault, isFinal, isNative, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile, setAbstract, setDefault, setFinal, setModifiers, setNative, setPrivate, setProtected, setPublic, setStatic, setStrictfp, setSynchronized, setTransient, setVolatile

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

getDeclarations, getTypeKind, isLocal

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

children, childrenAccept, getChild, getParent, getRoot, jjtAccept, 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, 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

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

getType, getTypeDefinition, setType, setTypeDefinition

Method Detail

isNested

public final boolean isNested()

Deprecated.

Description copied from interface: ASTAnyTypeDeclaration

Returns true if this type declaration is nested inside an interface, class or annotation.

Specified by:

isNested in interface ASTAnyTypeDeclaration

getImage

@Deprecated
@DeprecatedAttribute(replaceWith="@SimpleName")
public String getImage()

Deprecated.

Use getSimpleName()

Specified by:

getImage in interface ASTAnyTypeDeclaration

Specified by:

getImage in interface Node

Overrides:

getImage in class AbstractNode

getBinaryName

public String getBinaryName()

Deprecated.

Description copied from interface: ASTAnyTypeDeclaration

Returns the binary name of this type declaration. This is like Class.getName().

Specified by:

getBinaryName in interface ASTAnyTypeDeclaration

getSimpleName

public String getSimpleName()

Deprecated.

Description copied from interface: ASTAnyTypeDeclaration

Returns the simple name of this type declaration. Returns null if this is an anonymous class declaration.

Specified by:

getSimpleName in interface ASTAnyTypeDeclaration

getRecordComponents

public ASTRecordComponentList getRecordComponents()

Deprecated.

Returns the record component list, or null if this is not a record declaration.

enclosingTypeIsA

public final boolean enclosingTypeIsA(ASTAnyTypeDeclaration.TypeKind... kinds)

Deprecated.

Returns true if the enclosing type of this type declaration is any of the given kinds. If this declaration is a top-level declaration, returns false. This won't consider anonymous classes until #905 is tackled. TODO 7.0.0

Parameters:

kinds - Kinds to test

getEnclosingTypeDeclaration

public final ASTAnyTypeDeclaration getEnclosingTypeDeclaration()

Deprecated.

Returns the enclosing type of this type, if it is nested. Otherwise returns null. This won't consider anonymous classes until #905 is tackled. TODO 7.0.0

getQualifiedName

public final JavaTypeQualifiedName getQualifiedName()

Deprecated.

Description copied from interface: JavaQualifiableNode

Returns a qualified name for this node.

Specified by:

getQualifiedName in interface ASTAnyTypeDeclaration

Specified by:

getQualifiedName in interface JavaQualifiableNode

Specified by:

getQualifiedName in interface QualifiableNode

Returns:

A qualified name.

setQualifiedName

@InternalApi
@Deprecated
public void setQualifiedName(JavaTypeQualifiedName qualifiedName)

Deprecated.

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