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

Class ASTImportDeclaration

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.ASTImportDeclaration
All Implemented Interfaces:
GenericNode<JavaNode>, JjtreeNode<JavaNode>, Node, TextAvailableNode, ASTTopLevelDeclaration, JavaNode, Reportable
public final class ASTImportDeclaration extends AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode> implements ASTTopLevelDeclaration
Represents an import declaration in a Java file. 

 ImportDeclaration ::= "import" ("static" | "module")? Name ( "." "*" )? ";"
See Also:

  • Field Details

  • Method Details

    • isImportOnDemand

      public boolean isImportOnDemand()
      Returns true if this is an import-on-demand declaration, aka "wildcard import".
      • If this is a static import, then the imported names are those of the accessible static members of the named type;
      • Otherwise, the imported names are the names of the accessible types of the named type or named package.

    • isStatic

      public boolean isStatic()
      Returns true if this is a static import. If this import is not on-demand, getImportedSimpleName() returns the name of the imported member.

    • getImportedName

      public @NonNull String getImportedName()
      Returns the full name of the import. For on-demand imports, this is the name without the final dot and asterisk. For module declaration imports, this is the name of the module.

    • getImage

      public String getImage()
      Specified by:
      getImage in interface Node
      Overrides:
      getImage in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • getImportedSimpleName

      public String getImportedSimpleName()
      Returns the simple name of the type or method imported by this declaration. For on-demand imports, returns null.

      For module import declarations, this returns null. Use getImportedName() for the module name of a module import declaration.

    • getPackageName

      public String getPackageName()
      Returns the "package" prefix of the imported name. For type imports, including on-demand imports, this is really the package name of the imported type(s). For static imports, this is actually the qualified name of the enclosing type, including the type name.

      For module import declarations, this returns null. Use getImportedName() for the module name of a module import declaration.

    • acceptVisitor

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

    • isModuleImport

      public boolean isModuleImport()
      If this import declaration imports all the public top-level classes and interfaces of a module.
      Returns:
      true if this is a module declaration import
      Since:
      7.16.0
      See Also:

    • 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>

    • enlargeLeft

      protected void enlargeLeft(JavaccToken child)
      Overrides:
      enlargeLeft 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