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

Class ASTImportDeclaration

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

net.sourceforge.pmd.lang.java.ast.ASTImportDeclaration

All Implemented Interfaces:

Node, JavaNode, TypeNode, ScopedNode

public class ASTImportDeclaration
extends AbstractJavaTypeNode

Represents an import declaration in a Java file.

 ImportDeclaration ::= "import" "static"? Name ( "." "*" )? ";"

 

See Also:

JLS 7.5

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
ASTImportDeclaration(int id)	Deprecated.
ASTImportDeclaration(JavaParser p, int id)	Deprecated.

Method Summary

Modifier and Type	Method	Description
String	getImportedName()	Returns the full name of the import.
ASTName	getImportedNameNode()	Deprecated. this will be removed with PMD 7.0.0
String	getImportedSimpleName()	Returns the simple name of the type or method imported by this declaration.
Package	getPackage()	Deprecated. this will be removed with PMD 7.0.0
String	getPackageName()	Returns the "package" prefix of the imported name.
boolean	isImportOnDemand()	Returns true if this is an import-on-demand declaration, aka "wildcard import".
boolean	isStatic()	Returns true if this is a static import.
Object	jjtAccept(JavaParserVisitor visitor, Object data)	Calls back the visitor's visit method corresponding to the runtime type of this Node.
void	setImportOnDemand()	Deprecated. Will be made private with 7.0.0
void	setPackage(Package packge)	Deprecated.
void	setStatic()	Deprecated. Will be made private with 7.0.0

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

getType, getTypeDefinition, setType, setTypeDefinition

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

childrenAccept, comment, comment, getRoot, getScope, getXPathNodeName, 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, getImage, 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.JavaNode

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

Constructor Detail

ASTImportDeclaration

@InternalApi
@Deprecated
public ASTImportDeclaration(int id)

Deprecated.

ASTImportDeclaration

@InternalApi
@Deprecated
public ASTImportDeclaration(JavaParser p,
                            int id)

Deprecated.

Method Detail

setImportOnDemand

@InternalApi
@Deprecated
public void setImportOnDemand()

Deprecated.

Will be made private with 7.0.0

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.

setStatic

@InternalApi
@Deprecated
public void setStatic()

Deprecated.

Will be made private with 7.0.0

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.

getImportedNameNode

@Deprecated
public ASTName getImportedNameNode()

Deprecated.

this will be removed with PMD 7.0.0

getImportedName

public String getImportedName()

Returns the full name of the import. For on-demand imports, this is the name without the final dot and asterisk.

getImportedSimpleName

public String getImportedSimpleName()

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

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.

jjtAccept

public Object jjtAccept(JavaParserVisitor visitor,
                        Object data)

Description copied from interface: JavaNode

Calls back the visitor's visit method corresponding to the runtime type of this Node.

Specified by:

jjtAccept in interface JavaNode

Overrides:

jjtAccept in class AbstractJavaNode

Parameters:

visitor - Visitor to dispatch

data - Visit data

setPackage

@InternalApi
@Deprecated
public void setPackage(Package packge)

Deprecated.

getPackage

@Deprecated
public Package getPackage()

Deprecated.

this will be removed with PMD 7.0.0

Returns the Package instance representing the package of the type or method imported by this declaration. This may be null if the auxclasspath is not correctly set, as this method depends on correct type resolution.