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

Class ASTClassDeclaration

java.lang.Object
net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
net.sourceforge.pmd.lang.java.ast.ASTClassDeclaration
All Implemented Interfaces:
net.sourceforge.pmd.lang.ast.impl.GenericNode<JavaNode>, net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode<JavaNode>, net.sourceforge.pmd.lang.ast.Node, net.sourceforge.pmd.lang.ast.TextAvailableNode, Annotatable, ASTBodyDeclaration, ASTTopLevelDeclaration, ASTTypeDeclaration, JavadocCommentOwner, JavaNode, ModifierOwner, SymbolDeclaratorNode, TypeNode, TypeParamOwnerNode, net.sourceforge.pmd.reporting.Reportable
public final class ASTClassDeclaration extends net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
Represents class and interface declarations. This is a find boundary for tree traversal methods. 

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

  • Field Details

  • Method Details

    • acceptVisitor

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

    • isInterface

      public boolean isInterface()
      Description copied from interface: ASTTypeDeclaration
      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: ASTTypeDeclaration
      Returns true if this is a regular class declaration (not an enum, not a record, not an interface or annotation, not an implicit class). Note that eg JClassSymbol.isClass() counts records and enums in, just like ASTTypeDeclaration.isInterface() counts annotations in.

    • isRegularInterface

      public boolean isRegularInterface()
      Description copied from interface: ASTTypeDeclaration
      Returns true if this is a regular interface declaration (not an annotation). Note that ASTTypeDeclaration.isInterface() counts annotations in.

    • getPermittedSubclasses

      @Deprecated public List<ASTClassType> getPermittedSubclasses()
      Deprecated.
      Use ASTTypeDeclaration.getPermitsClause() or JClassSymbol.getPermittedSubtypes()

    • getReportLocation

      public net.sourceforge.pmd.lang.document.FileLocation getReportLocation()
      Specified by:
      getReportLocation in interface net.sourceforge.pmd.lang.ast.Node
      Specified by:
      getReportLocation in interface net.sourceforge.pmd.reporting.Reportable

    • getSimpleName

      public @NonNull String getSimpleName()
      Description copied from interface: ASTTypeDeclaration
      Returns the simple name of this type declaration. Returns the empty string if this is an anonymous class declaration.
      Specified by:
      getSimpleName in interface ASTTypeDeclaration

    • getBinaryName

      public @NonNull String getBinaryName()
      Description copied from interface: ASTTypeDeclaration
      Returns the binary name of this type declaration. This is like Class.getName().
      Specified by:
      getBinaryName in interface ASTTypeDeclaration

    • getCanonicalName

      public @Nullable String getCanonicalName()
      Description copied from interface: ASTTypeDeclaration
      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 ASTTypeDeclaration

    • getVisibility

      public ModifierOwner.Visibility getVisibility()
      Description copied from interface: ModifierOwner
      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 ModifierOwner.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 ModifierOwner

    • 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 ASTTypeDeclaration
      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 net.sourceforge.pmd.lang.ast.Node

    • getSymbol

      public JClassSymbol 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 net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • acceptVisitor

      public final <P, R> R acceptVisitor(net.sourceforge.pmd.lang.ast.AstVisitor<? super P,? extends R> visitor, P data)
      Specified by:
      acceptVisitor in interface net.sourceforge.pmd.lang.ast.Node

    • addChild

      protected void addChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
      Overrides:
      addChild in class net.sourceforge.pmd.lang.ast.impl.javacc.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 net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • removeChildAtIndex

      protected void removeChildAtIndex(int childIndex)
      Overrides:
      removeChildAtIndex in class net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • setImage

      protected void setImage(String image)
      Overrides:
      setImage in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • setFirstToken

      protected void setFirstToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)
      Overrides:
      setFirstToken in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • setLastToken

      protected void setLastToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)
      Overrides:
      setLastToken in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • enlargeLeft

      protected void enlargeLeft(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken child)
      Overrides:
      enlargeLeft in class net.sourceforge.pmd.lang.ast.impl.javacc.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 net.sourceforge.pmd.lang.ast.impl.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 net.sourceforge.pmd.lang.ast.Node

    • getXPathNodeName

      public final String getXPathNodeName()
      Specified by:
      getXPathNodeName in interface net.sourceforge.pmd.lang.ast.Node