com.github.javaparser.ast

Class ImportDeclaration

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.ImportDeclaration

All Implemented Interfaces:

Cloneable

public final class ImportDeclaration
extends Node

This class represents a import declaration or an empty import declaration. Imports are optional for the CompilationUnit.

The ImportDeclaration is constructed following the syntax:

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

An enmpty import declaration is simply a semicolon among the import declarations.

Author:

Julio Vilmar Gesser

Field Summary

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

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE

Constructor Summary

Constructors

Constructor and Description
ImportDeclaration(NameExpr name, boolean isStatic, boolean isAsterisk)
ImportDeclaration(Range range, NameExpr name, boolean isStatic, boolean isAsterisk)

Method Summary

Modifier and Type	Method and 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.
static ImportDeclaration	createEmptyDeclaration() Create an empty import declaration without specifying its position.
static ImportDeclaration	createEmptyDeclaration(Range range) Create an empty import declaration specifying its position.
NameExpr	getName() Retrieves the name of the import.
boolean	isAsterisk() Return if the import ends with "*".
boolean	isEmptyImportDeclaration() Is this an empty import declaration or a normal import declaration?
boolean	isStatic() Return if the import is static.
ImportDeclaration	setAsterisk(boolean asterisk) Sets if this import is asterisk.
ImportDeclaration	setName(NameExpr name) Sets the name this import.
ImportDeclaration	setStatic(boolean static_) Sets if this import is static.

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

addOrphanComment, clone, contains, equals, getAllContainedComments, getBegin, getChildrenNodes, getComment, getEnd, getNodesByType, getOrphanComments, getParentNode, getParentNodeOfType, getRange, getUserData, hasComment, hashCode, isPositionedAfter, isPositionedBefore, setAsParentNodeOf, setAsParentNodeOf, setBegin, setBlockComment, setComment, setEnd, setLineComment, setParentNode, setRange, setUserData, toString, toStringWithoutComments, tryAddImportToParentCompilationUnit

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportDeclaration

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

ImportDeclaration

public ImportDeclaration(Range range,
                         NameExpr name,
                         boolean isStatic,
                         boolean isAsterisk)

Method Detail

createEmptyDeclaration

public static ImportDeclaration createEmptyDeclaration()

Create an empty import declaration without specifying its position.

createEmptyDeclaration

public static ImportDeclaration createEmptyDeclaration(Range range)

Create an empty import declaration specifying its position.

isEmptyImportDeclaration

public boolean isEmptyImportDeclaration()

Is this an empty import declaration or a normal import declaration?

accept

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

Description copied from class: Node

Accept method for visitor support.

Specified by:

accept in class Node

Type Parameters:

R - the type the return value of the visitor

A - the type the argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor

Returns:

the result of the visit

accept

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

Description copied from class: Node

Accept method for visitor support.

Specified by:

accept in class Node

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor

getName

public NameExpr getName()

Retrieves the name of the import.

Returns:

the name of the import

Throws:

UnsupportedOperationException - when invoked on an empty import declaration

isAsterisk

public boolean isAsterisk()

Return if the import ends with "*".

Returns:

true if the import ends with "*", false otherwise

isStatic

public boolean isStatic()

Return if the import is static.

Returns:

true if the import is static, false otherwise

setAsterisk

public ImportDeclaration setAsterisk(boolean asterisk)

Sets if this import is asterisk.

Parameters:

asterisk - true if this import is asterisk

Throws:

UnsupportedOperationException - when setting true on an empty import declaration

setName

public ImportDeclaration setName(NameExpr name)

Sets the name this import.

Parameters:

name - the name to set

Throws:

UnsupportedOperationException - when invoked on an empty import declaration

setStatic

public ImportDeclaration setStatic(boolean static_)

Sets if this import is static.

Parameters:

static_ - true if this import is static

Throws:

UnsupportedOperationException - when setting true on an empty import declaration