com.github.antlrjavaparser.api

Class CompilationUnit

java.lang.Object

com.github.antlrjavaparser.api.Node

com.github.antlrjavaparser.api.CompilationUnit

public final class CompilationUnit
extends Node

This class represents the entire compilation unit. Each java file denotes a compilation unit.

The CompilationUnit is constructed following the syntax:

CompilationUnit

::=

( PackageDeclaration )? ( ImportDeclaration )* ( TypeDeclaration )*

Author:

Julio Vilmar Gesser

Constructor Summary

Constructors

Constructor and Description
CompilationUnit()
CompilationUnit(int beginLine, int beginColumn, int endLine, int endColumn, PackageDeclaration pakage, List<ImportDeclaration> imports, List<TypeDeclaration> types, List<Comment> comments)
CompilationUnit(PackageDeclaration pakage, List<ImportDeclaration> imports, List<TypeDeclaration> types, List<Comment> comments)

Method Summary

Methods

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.
List<Comment>	getComments() Return a list containing all comments declared in this compilation unit.
List<ImportDeclaration>	getImports() Retrieves the list of imports declared in this compilation unit or null if there is no import.
PackageDeclaration	getPackage() Retrieves the package declaration of this compilation unit. If this compilation unit has no package declaration (default package), null is returned.
List<TypeDeclaration>	getTypes() Return the list of types declared in this compilation unit. If there is no types declared, null is returned.
void	setComments(List<Comment> comments) Sets the list of comments of this compilation unit.
void	setImports(List<ImportDeclaration> imports) Sets the list of imports of this compilation unit.
void	setPackage(PackageDeclaration pakage) Sets or clear the package declarations of this compilation unit.
void	setTypes(List<TypeDeclaration> types) Sets the list of types declared in this compilation unit.

Methods inherited from class com.github.antlrjavaparser.api.Node

equals, getBeginColumn, getBeginComments, getBeginIndex, getBeginLine, getData, getEndColumn, getEndComments, getEndIndex, getEndLine, getInternalComments, hashCode, setBeginColumn, setBeginComments, setBeginIndex, setBeginLine, setData, setEndColumn, setEndComments, setEndIndex, setEndLine, setInternalComments, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CompilationUnit

public CompilationUnit()

CompilationUnit

public CompilationUnit(PackageDeclaration pakage,
               List<ImportDeclaration> imports,
               List<TypeDeclaration> types,
               List<Comment> comments)

CompilationUnit

public CompilationUnit(int beginLine,
               int beginColumn,
               int endLine,
               int endColumn,
               PackageDeclaration pakage,
               List<ImportDeclaration> imports,
               List<TypeDeclaration> types,
               List<Comment> comments)

Method Detail

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 for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for 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

getComments

public List<Comment> getComments()

Return a list containing all comments declared in this compilation unit. Including javadocs, line comments and block comments of all types, inner-classes and other members.
If there is no comment, null is returned.

Returns:

list with all comments of this compilation unit or null

See Also:

JavadocComment, LineComment, BlockComment

getImports

public List<ImportDeclaration> getImports()

Retrieves the list of imports declared in this compilation unit or null if there is no import.

Returns:

the list of imports or null if there is no import

getPackage

public PackageDeclaration getPackage()

Retrieves the package declaration of this compilation unit.
If this compilation unit has no package declaration (default package), null is returned.

Returns:

the package declaration or null

getTypes

public List<TypeDeclaration> getTypes()

Return the list of types declared in this compilation unit.
If there is no types declared, null is returned.

Returns:

the list of types or null null if there is no type

See Also:

AnnotationDeclaration, ClassOrInterfaceDeclaration, EmptyTypeDeclaration, EnumDeclaration

setComments

public void setComments(List<Comment> comments)

Sets the list of comments of this compilation unit.

Parameters:

comments - the list of comments

setImports

public void setImports(List<ImportDeclaration> imports)

Sets the list of imports of this compilation unit. The list is initially null.

Parameters:

imports - the list of imports

setPackage

public void setPackage(PackageDeclaration pakage)

Sets or clear the package declarations of this compilation unit.

Parameters:

pakage - the pakage declaration to set or null to default package

setTypes

public void setTypes(List<TypeDeclaration> types)

Sets the list of types declared in this compilation unit.

Parameters:

types - the lis of types