com.github.javaparser.ast.imports

Class ImportDeclaration

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.imports.ImportDeclaration

All Implemented Interfaces:

Observable, Visitable, HasParentNode<Node>, Cloneable

Direct Known Subclasses:

EmptyImportDeclaration, NonEmptyImportDeclaration

public abstract class ImportDeclaration
extends Node

This class is a base class for classes representing import declarations. Imports are optional for the CompilationUnit.

The ImportDeclaration is constructed following the syntax:

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

An EmptyImportDeclaration is simply a semicolon among the import declarations.

JLS 7.5. Import Declarations

Author:

Julio Vilmar Gesser

Nested Class Summary

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

Node.ObserverRegistrationMode

Field Summary

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

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration

Constructor Summary

Constructors

Constructor and Description
ImportDeclaration()
ImportDeclaration(Range range)

Method Summary

Modifier and Type	Method and Description
static ImportDeclaration	create(Range range, Name name, boolean isStatic, boolean isAsterisk) Factory method for import declarations.

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

addOrphanComment, clone, containsWithin, equals, getAllContainedComments, getBegin, getChildNodes, getComment, getEnd, getNodeLists, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getRange, getUserData, hasComment, hashCode, isPositionedAfter, isPositionedBefore, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, setAsParentNodeOf, setBegin, setBlockComment, setComment, setEnd, setLineComment, setParentNode, setRange, setUserData, toString, toString, tryAddImportToParentCompilationUnit, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.javaparser.HasParentNode

getAncestorOfType, setAsParentNodeOf, setAsParentNodeOf

Methods inherited from interface com.github.javaparser.ast.visitor.Visitable

accept, accept

Constructor Detail

ImportDeclaration

public ImportDeclaration()

ImportDeclaration

public ImportDeclaration(Range range)

Method Detail

create

public static ImportDeclaration create(Range range,
                                       Name name,
                                       boolean isStatic,
                                       boolean isAsterisk)

Factory method for import declarations.

Parameters:

range - the range the import declaration covers. Range.UNKNOWN if not known.

name - the qualified name of the import.

isStatic - whether the import is static.

isAsterisk - whether the import is on demand.