com.github.javaparser.ast

Class PackageDeclaration

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.PackageDeclaration

All Implemented Interfaces:

NodeWithAnnotations<PackageDeclaration>, Visitable, HasParentNode<Node>, Cloneable

public final class PackageDeclaration
extends Node
implements NodeWithAnnotations<PackageDeclaration>

This class represents the package declaration. The package declaration is optional for the CompilationUnit.

The PackageDeclaration is constructed following the syntax:

 
 PackageDeclaration ::= ( AnnotationExpr )* "package" NameExpr ) ";"
 
 

Author:

Julio Vilmar Gesser

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
PackageDeclaration()
PackageDeclaration(NameExpr name)
PackageDeclaration(NodeList<AnnotationExpr> annotations, NameExpr name)
PackageDeclaration(Range range, NodeList<AnnotationExpr> annotations, NameExpr name)

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.
NodeList<AnnotationExpr>	getAnnotations() Retrieves the list of annotations declared before the package declaration.
NameExpr	getName() Return the name expression of the package.
String	getPackageName() Get full package name.
PackageDeclaration	setAnnotations(NodeList<AnnotationExpr> annotations)
PackageDeclaration	setName(NameExpr name) Sets the name of this package declaration.

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

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

Methods inherited from class java.lang.Object

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

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

addAnnotation, addAnnotation, addMarkerAnnotation, addMarkerAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, getAnnotationByClass, getAnnotationByName, isAnnotationPresent, isAnnotationPresent

Methods inherited from interface com.github.javaparser.HasParentNode

getAncestorOfType, setAsParentNodeOf, setAsParentNodeOf

Constructor Detail

PackageDeclaration

public PackageDeclaration()

PackageDeclaration

public PackageDeclaration(NameExpr name)

PackageDeclaration

public PackageDeclaration(NodeList<AnnotationExpr> annotations,
                          NameExpr name)

PackageDeclaration

public PackageDeclaration(Range range,
                          NodeList<AnnotationExpr> annotations,
                          NameExpr name)

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)

getAnnotations

public NodeList<AnnotationExpr> getAnnotations()

Retrieves the list of annotations declared before the package declaration. Return null if there are no annotations.

Specified by:

getAnnotations in interface NodeWithAnnotations<PackageDeclaration>

Returns:

list of annotations or null

getName

public NameExpr getName()

Return the name expression of the package.

Returns:

the name of the package

getPackageName

public String getPackageName()

Get full package name.

setAnnotations

public PackageDeclaration setAnnotations(NodeList<AnnotationExpr> annotations)

Specified by:

setAnnotations in interface NodeWithAnnotations<PackageDeclaration>

Parameters:

annotations - the annotations to set

setName

public PackageDeclaration setName(NameExpr name)

Sets the name of this package declaration.

Parameters:

name - the name to set