Package com.github.javaparser.ast

Class ImportDeclaration

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.ImportDeclaration

All Implemented Interfaces:

NodeWithName<ImportDeclaration>, NodeWithRange<Node>, NodeWithTokenRange<Node>, Observable, Visitable, HasParentNode<Node>, java.lang.Cloneable

public class ImportDeclaration
extends Node
implements NodeWithName<ImportDeclaration>

An import declaration.
import com.github.javaparser.JavaParser;
import com.github.javaparser.*;
import com.github.javaparser.JavaParser.*;
import static com.github.javaparser.JavaParser.*;
import static com.github.javaparser.JavaParser.parse;

The name does not include the asterisk or the static keyword.

Nested Class Summary

Nested classes/interfaces inherited from class com.github.javaparser.ast.Node

Node.BreadthFirstIterator, Node.DirectChildrenIterator, Node.ObserverRegistrationMode, Node.ParentsVisitor, Node.Parsedness, Node.PostOrderIterator, Node.PreOrderIterator, Node.TreeTraversal

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isAsterisk
private boolean	isModule
private boolean	isStatic
private Name	name

Fields inherited from class com.github.javaparser.ast.Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, LINE_SEPARATOR_KEY, NODE_BY_BEGIN_POSITION, PHANTOM_KEY, prettyPrinterNoCommentsConfiguration, PRINTER_KEY, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ImportDeclaration()
	ImportDeclaration(Name name, boolean isStatic, boolean isAsterisk)	This constructor is kept to avoid breaking existing code creating non-module imports.
	ImportDeclaration(Name name, boolean isStatic, boolean isAsterisk, boolean isModule)
	ImportDeclaration(TokenRange tokenRange, Name name, boolean isStatic, boolean isAsterisk)	This constructor is kept to avoid breaking existing code creating non-module imports.
	ImportDeclaration(TokenRange tokenRange, Name name, boolean isStatic, boolean isAsterisk, boolean isModule)	This constructor is used by the parser and is considered private.
	ImportDeclaration(java.lang.String name, boolean isStatic, boolean isAsterisk)	This constructor is kept to avoid breaking existing code creating non-module imports.
	ImportDeclaration(java.lang.String name, boolean isStatic, boolean isAsterisk, boolean isModule)

Method Summary

Modifier and Type	Method	Description
<R,A> R	accept(GenericVisitor<R,A> v, A arg)	Accept method for visitor support.
<A> void	accept(VoidVisitor<A> v, A arg)	Accept method for visitor support.
ImportDeclaration	clone()
ImportDeclarationMetaModel	getMetaModel()
Name	getName()	Retrieves the name of the import (.* is not included.)
private static Name	getNameFromString(java.lang.String name)	Returns the name of the import.
private static boolean	hasAsterisk(java.lang.String name)	Returns true if the specified name has an asterisk
boolean	isAsterisk()	Return if the import ends with "*".
boolean	isModule()
private static boolean	isQualified(java.lang.String name)	Returns true if the specified name is qualified
boolean	isStatic()
boolean	replace(Node node, Node replacementNode)
ImportDeclaration	setAsterisk(boolean isAsterisk)
ImportDeclaration	setModule(boolean isModule)
ImportDeclaration	setName(Name name)
ImportDeclaration	setStatic(boolean isStatic)

Methods inherited from class com.github.javaparser.ast.Node

addOrphanComment, containsData, createDefaultPrinter, createDefaultPrinter, customInitialization, equals, findAll, findAll, findAll, findByRange, findCompilationUnit, findData, findFirst, findFirst, findFirst, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getDataKeys, getDefaultPrinterConfiguration, getLineEndingStyle, getLineEndingStyleOrDefault, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getPrinter, getPrinter, getRange, getSymbolResolver, getTokenRange, hashCode, hasScope, isAncestorOf, isPhantom, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, stream, stream, toString, toString, tryAddImportToParentCompilationUnit, unregister, walk, walk, walk

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.github.javaparser.HasParentNode

findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithName

getNameAsString, setName

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithRange

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Field Detail

name

private Name name

isStatic

private boolean isStatic

isAsterisk

private boolean isAsterisk

isModule

private boolean isModule

Constructor Detail

ImportDeclaration

private ImportDeclaration()

ImportDeclaration

public ImportDeclaration(java.lang.String name,
                         boolean isStatic,
                         boolean isAsterisk,
                         boolean isModule)

ImportDeclaration

public ImportDeclaration(java.lang.String name,
                         boolean isStatic,
                         boolean isAsterisk)

This constructor is kept to avoid breaking existing code creating non-module imports.

ImportDeclaration

public ImportDeclaration(Name name,
                         boolean isStatic,
                         boolean isAsterisk,
                         boolean isModule)

ImportDeclaration

public ImportDeclaration(Name name,
                         boolean isStatic,
                         boolean isAsterisk)

This constructor is kept to avoid breaking existing code creating non-module imports.

ImportDeclaration

public ImportDeclaration(TokenRange tokenRange,
                         Name name,
                         boolean isStatic,
                         boolean isAsterisk,
                         boolean isModule)

This constructor is used by the parser and is considered private.

ImportDeclaration

public ImportDeclaration(TokenRange tokenRange,
                         Name name,
                         boolean isStatic,
                         boolean isAsterisk)

This constructor is kept to avoid breaking existing code creating non-module imports.

Method Detail

accept

public <R,A> R accept(GenericVisitor<R,A> v,
                            A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

R - the type of the return value of the visitor

A - the type the user argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor (of type A)

Returns:

the result of the visit (of type R)

accept

public <A> void accept(VoidVisitor<A> v,
                       A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor (of type A)

isQualified

private static boolean isQualified(java.lang.String name)

Returns true if the specified name is qualified

hasAsterisk

private static boolean hasAsterisk(java.lang.String name)

Returns true if the specified name has an asterisk

getNameFromString

private static Name getNameFromString(java.lang.String name)

Returns the name of the import. The name can have a qualifier. For example, the java.util.Map class would have a qualifier ‘java.util’ and an identifier ‘name’ and the qualifier would have a qualifier ‘java’ and an identifier ‘util’ and so on.

getName

public Name getName()

Retrieves the name of the import (.* is not included.)

Specified by:

getName in interface NodeWithName<ImportDeclaration>

isAsterisk

public boolean isAsterisk()

Return if the import ends with "*".

isModule

public boolean isModule()

isStatic

public boolean isStatic()

setAsterisk

public ImportDeclaration setAsterisk(boolean isAsterisk)

setName

public ImportDeclaration setName(Name name)

Specified by:

setName in interface NodeWithName<ImportDeclaration>

setStatic

public ImportDeclaration setStatic(boolean isStatic)

clone

public ImportDeclaration clone()

Overrides:

clone in class Node

getMetaModel

public ImportDeclarationMetaModel getMetaModel()

Overrides:

getMetaModel in class Node

Returns:

get JavaParser specific node introspection information.

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class Node

setModule

public ImportDeclaration setModule(boolean isModule)