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

Interface ASTAnyTypeDeclaration

All Superinterfaces:

AccessNode, JavaNode, JavaQualifiableNode, net.sourceforge.pmd.lang.ast.Node, net.sourceforge.pmd.lang.ast.QualifiableNode, net.sourceforge.pmd.lang.symboltable.ScopedNode, TypeNode

All Known Implementing Classes:

AbstractAnyTypeDeclaration, ASTAnnotationTypeDeclaration, ASTClassOrInterfaceDeclaration, ASTEnumDeclaration, ASTRecordDeclaration

public interface ASTAnyTypeDeclaration
extends TypeNode, JavaQualifiableNode, AccessNode, JavaNode

Groups class, enum, record, annotation and interface declarations.

Author:

Clément Fournier

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ASTAnyTypeDeclaration.TypeKind	Deprecated. This is not useful, not adapted to the problem, and does not scale to changes in the Java language.

Field Summary

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

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

Method Summary

Modifier and Type	Method	Description
String	getBinaryName()	Returns the binary name of this type declaration.
List<ASTAnyTypeBodyDeclaration>	getDeclarations()	Retrieves the member declarations (fields, methods, classes, etc.) from the body of this type declaration.
String	getImage()	Deprecated. Use getSimpleName()
JavaTypeQualifiedName	getQualifiedName()	Deprecated. Use getBinaryName()
String	getSimpleName()	Returns the simple name of this type declaration.
ASTAnyTypeDeclaration.TypeKind	getTypeKind()	Deprecated. See ASTAnyTypeDeclaration.TypeKind
boolean	isNested()	Returns true if this type declaration is nested inside an interface, class or annotation.

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

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

getSimpleName

String getSimpleName()

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

getImage

@Deprecated
String getImage()

Deprecated.

Use getSimpleName()

Specified by:

getImage in interface net.sourceforge.pmd.lang.ast.Node

getBinaryName

String getBinaryName()

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

getTypeKind

@Deprecated
ASTAnyTypeDeclaration.TypeKind getTypeKind()

Deprecated.

See ASTAnyTypeDeclaration.TypeKind

Finds the type kind of this declaration.

Returns:

The type kind of this declaration.

getDeclarations

List<ASTAnyTypeBodyDeclaration> getDeclarations()

Retrieves the member declarations (fields, methods, classes, etc.) from the body of this type declaration.

Returns:

The member declarations declared in this type declaration

getQualifiedName

@Deprecated
JavaTypeQualifiedName getQualifiedName()

Deprecated.

Use getBinaryName()

Description copied from interface: JavaQualifiableNode

Returns a qualified name for this node.

Specified by:

getQualifiedName in interface JavaQualifiableNode

Specified by:

getQualifiedName in interface net.sourceforge.pmd.lang.ast.QualifiableNode

Returns:

A qualified name.

isNested

boolean isNested()

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