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

Class ASTClassOrInterfaceDeclaration

java.lang.Object

net.sourceforge.pmd.lang.ast.impl.AbstractNode<B,N>

net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

net.sourceforge.pmd.lang.java.ast.ASTClassOrInterfaceDeclaration

All Implemented Interfaces:

GenericNode<JavaNode>, JjtreeNode<JavaNode>, Node, TextAvailableNode, AccessNode, Annotatable, ASTAnyTypeDeclaration, ASTBodyDeclaration, ASTTopLevelDeclaration, FinalizableNode, JavadocCommentOwner, JavaNode, SymbolDeclaratorNode, TypeNode, TypeParamOwnerNode, Reportable

public final class ASTClassOrInterfaceDeclaration
extends AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

Represents class and interface declarations. This is a find boundary for tree traversal methods.

 ClassOrInterfaceDeclaration ::= ModifierList
                                 ( "class" | "interface" )
                                 <IDENTIFIER>
                                 TypeParameters?
                                 ExtendsList?
                                 ImplementsList?
                                 ClassOrInterfaceBody

 

Nested Class Summary

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

AccessNode.Visibility

Field Summary

Fields

Modifier and Type	Field	Description
protected JSymbolTable	symbolTable

Fields inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode

id

Fields inherited from interface net.sourceforge.pmd.lang.ast.Node

COORDS_COMPARATOR

Method Summary

Modifier and Type	Method	Description
<P,R> R	acceptVisitor(AstVisitor<? super P,? extends R> visitor, P data)
protected <P,R> R	acceptVisitor(JavaVisitor<? super P,? extends R> visitor, P data)
protected void	addChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
@NonNull String	getBinaryName()	Returns the binary name of this type declaration.
@Nullable String	getCanonicalName()	Returns the canonical name of this class, if it exists.
String	getImage()	Deprecated. Use ASTAnyTypeDeclaration.getSimpleName()
List<ASTClassOrInterfaceType>	getPermittedSubclasses()
FileLocation	getReportLocation()
@NonNull ASTCompilationUnit	getRoot()
@NonNull String	getSimpleName()	Returns the simple name of this type declaration.
ASTClassOrInterfaceType	getSuperClassTypeNode()	Returns the superclass type node if this node is a class declaration and explicitly declares an extends clause.
@NonNull T	getSymbol()	Returns the symbol this node declares.
@NonNull JSymbolTable	getSymbolTable()	Returns the symbol table for the program point represented by this node.
@NonNull JClassType	getTypeMirror()	Returns the compile-time type of this node.
@NonNull JTypeMirror	getTypeMirror(TypingContext context)
TypeSystem	getTypeSystem()	Returns the type system with which this node was created.
AccessNode.Visibility	getVisibility()	Returns the visibility corresponding to the effective modifiers.
String	getXPathNodeName()
protected void	insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
boolean	isFindBoundary()
boolean	isInterface()	Returns true if this is an interface type declaration (including annotation types).
boolean	isPackagePrivate()
boolean	isRegularClass()	Returns true if this is a regular class declaration (not an enum, not a record, not an interface or annotation).
boolean	isRegularInterface()	Returns true if this is a regular interface declaration (not an annotation).
void	jjtClose()
protected void	removeChildAtIndex(int childIndex)
protected void	setChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
protected void	setFirstToken(JavaccToken token)
protected void	setImage(String image)
protected void	setLastToken(JavaccToken token)

Methods inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode

compareLocation, fitTokensToChildren, getFirstToken, getLastToken, getTextRegion, jjtOpen, toString

Methods inherited from class net.sourceforge.pmd.lang.ast.impl.AbstractNode

children, firstChild, getChild, getIndexInParent, getNumChildren, getParent, getUserMap, remove, setParent

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

getDeclaredAnnotations, getEffectiveVisibility, getModifiers, hasExplicitModifiers, hasModifiers, isNative, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSynchronized, isSyntacticallyAbstract, isSyntacticallyFinal, isSyntacticallyPublic, isSyntacticallyStatic, isTransient, isVolatile

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

getAnnotation, isAnnotationPresent, isAnnotationPresent, isAnyAnnotationPresent

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

getBody, getDeclarations, getDeclarations, getEnumConstants, getOperations, getPackageName, getRecordComponents, getSuperInterfaceTypeNodes, getSymbol, isAbstract, isAnnotation, isAnonymous, isEnum, isLocal, isNested, isRecord, isTopLevel

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

isFinal

Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.GenericNode

ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getChild, getFirstChild, getLastChild, getNextSibling, getNthParent, getParent, getPreviousSibling

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

getJavadocComment

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

getEnclosingType, getRoot, getSymbolTable, getTypeSystem, jjtAccept

Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode

getFirstToken, getLastToken, tokens

Methods inherited from interface net.sourceforge.pmd.lang.ast.Node

acceptVisitor, ancestors, children, compareLocation, descendants, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, firstChild, getAstInfo, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfType, getIndexInParent, getLanguageVersion, getNumChildren, getParentsOfType, getTextDocument, getUserMap, getXPathAttributesIterator, getXPathNodeName, hasDescendantOfType, hasImageEqualTo

Methods inherited from interface net.sourceforge.pmd.lang.ast.TextAvailableNode

getOriginalText, getText, getTextRegion

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

getType, getTypeMirror

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

getTypeParameters

Field Detail

symbolTable

protected JSymbolTable symbolTable

Method Detail

acceptVisitor

protected <P,R> R acceptVisitor(JavaVisitor<? super P,? extends R> visitor,
                                      P data)

isPackagePrivate

public boolean isPackagePrivate()

isInterface

public boolean isInterface()

Description copied from interface: ASTAnyTypeDeclaration

Returns true if this is an interface type declaration (including annotation types). This is consistent with Class.isInterface().

isRegularClass

public boolean isRegularClass()

Description copied from interface: ASTAnyTypeDeclaration

Returns true if this is a regular class declaration (not an enum, not a record, not an interface or annotation). Note that eg JClassSymbol.isClass() counts records and enums in, just like ASTAnyTypeDeclaration.isInterface() counts annotations in.

isRegularInterface

public boolean isRegularInterface()

Description copied from interface: ASTAnyTypeDeclaration

Returns true if this is a regular interface declaration (not an annotation). Note that ASTAnyTypeDeclaration.isInterface() counts annotations in.

getSuperClassTypeNode

public ASTClassOrInterfaceType getSuperClassTypeNode()

Returns the superclass type node if this node is a class declaration and explicitly declares an extends clause. Superinterfaces of an interface are not considered.

Returns null otherwise.

getPermittedSubclasses

public List<ASTClassOrInterfaceType> getPermittedSubclasses()

getReportLocation

public FileLocation getReportLocation()

Specified by:

getReportLocation in interface Node

Specified by:

getReportLocation in interface Reportable

getImage

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

Deprecated.

Use ASTAnyTypeDeclaration.getSimpleName()

Specified by:

getImage in interface ASTAnyTypeDeclaration

Specified by:

getImage in interface Node

Overrides:

getImage in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

getSimpleName

public @NonNull String getSimpleName()

Description copied from interface: ASTAnyTypeDeclaration

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

Specified by:

getSimpleName in interface ASTAnyTypeDeclaration

getBinaryName

public @NonNull String getBinaryName()

Description copied from interface: ASTAnyTypeDeclaration

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

Specified by:

getBinaryName in interface ASTAnyTypeDeclaration

getCanonicalName

public @Nullable String getCanonicalName()

Description copied from interface: ASTAnyTypeDeclaration

Returns the canonical name of this class, if it exists. Otherwise returns null. This is like Class.getCanonicalName().

A canonical name exists if all enclosing types have a canonical name, and this is neither a local class nor an anonymous class. For example:

 package p;

 public class A { // p.A
     class M { // p.A.M
         {
             class Local { // null, local class
                class M2 {} // null, member of a local class
             }

             new Local() { // null, anonymous class
                class M2 {} // null, member of an anonymous class
             };
         }
     }

 }
 

So non-local/anonymous classes declared somewhere in a local/anonymous class also have no loc

Specified by:

getCanonicalName in interface ASTAnyTypeDeclaration

getVisibility

public AccessNode.Visibility getVisibility()

Description copied from interface: AccessNode

Returns the visibility corresponding to the effective modifiers. Eg a public method will have visibility public, a local class will have visibility local. There cannot be any conflict with AccessNode.hasModifiers(JModifier, JModifier...)} on well-formed code (e.g. for any n, (n.getVisibility() == V_PROTECTED) == n.hasModifiers(PROTECTED))

TODO a public method of a private class can be considered to be private we could probably add another method later on that takes this into account

Specified by:

getVisibility in interface AccessNode

getTypeMirror

public @NonNull JClassType getTypeMirror()

Description copied from interface: TypeNode

Returns the compile-time type of this node. For example, for a string literal, returns the type mirror for String, for a method call, returns the return type of the call, etc.

This method ignores conversions applied to the value of the node because of its context. For example, in 1 + "", the numeric literal will have type int, but it is converted to String by the surrounding concatenation expression. Similarly, in Collections.singletonList(1), the ASTNumericLiteral node has type int, but the type of the method formal is Integer, and boxing is applied at runtime. Possibly, an API will be added to expose this information.

Specified by:

getTypeMirror in interface ASTAnyTypeDeclaration

Specified by:

getTypeMirror in interface TypeNode

Returns:

The type mirror. Never returns null; if the type is unresolved, returns TypeSystem.UNKNOWN.

isFindBoundary

public boolean isFindBoundary()

Specified by:

isFindBoundary in interface Node

getSymbol

public @NonNull T getSymbol()

Description copied from interface: SymbolDeclaratorNode

Returns the symbol this node declares.

Specified by:

getSymbol in interface SymbolDeclaratorNode

getTypeMirror

public @NonNull JTypeMirror getTypeMirror(TypingContext context)

Specified by:

getTypeMirror in interface TypeNode

jjtClose

public void jjtClose()

Overrides:

jjtClose in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

acceptVisitor

public final <P,R> R acceptVisitor(AstVisitor<? super P,? extends R> visitor,
                                         P data)

Specified by:

acceptVisitor in interface Node

addChild

protected void addChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child,
                        int index)

Overrides:

addChild in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

insertChild

protected void insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child,
                           int index)

Overrides:

insertChild in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

removeChildAtIndex

protected void removeChildAtIndex(int childIndex)

Overrides:

removeChildAtIndex in class AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

setImage

protected void setImage(String image)

Overrides:

setImage in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

setFirstToken

protected void setFirstToken(JavaccToken token)

Overrides:

setFirstToken in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

setLastToken

protected void setLastToken(JavaccToken token)

Overrides:

setLastToken in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

setChild

protected void setChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child,
                        int index)

Overrides:

setChild in class AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

getSymbolTable

public @NonNull JSymbolTable getSymbolTable()

Description copied from interface: JavaNode

Returns the symbol table for the program point represented by this node.

Specified by:

getSymbolTable in interface JavaNode

getTypeSystem

public TypeSystem getTypeSystem()

Description copied from interface: JavaNode

Returns the type system with which this node was created. This is the object responsible for representing types in the compilation unit.

Specified by:

getTypeSystem in interface JavaNode

getRoot

public final @NonNull ASTCompilationUnit getRoot()

Specified by:

getRoot in interface JavaNode

Specified by:

getRoot in interface Node

getXPathNodeName

public final String getXPathNodeName()

Specified by:

getXPathNodeName in interface Node