com.github.javaparser.ast

Class PackageDeclaration

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.PackageDeclaration

All Implemented Interfaces:

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

public final class PackageDeclaration
extends Node
implements NodeWithAnnotations<PackageDeclaration>, NodeWithName<PackageDeclaration>

A package declaration.
package com.github.javaparser.ast;
@Wonderful package anything.can.be.annotated.nowadays;

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
PackageDeclaration()
PackageDeclaration(Name name)
PackageDeclaration(NodeList<AnnotationExpr> annotations, Name name)
PackageDeclaration(Range range, NodeList<AnnotationExpr> annotations, Name 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.
Name	getName() Return the name expression of the package.
List<NodeList<?>>	getNodeLists() The list of NodeLists owned by this node.
PackageDeclaration	setAnnotations(NodeList<AnnotationExpr> annotations)
PackageDeclaration	setName(Name 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, getData, getEnd, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getRange, hasComment, hashCode, hasJavaDocComment, isPositionedAfter, isPositionedBefore, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeOrphanComment, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setRange, 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.ast.nodeTypes.NodeWithAnnotations

addAnnotation, addAnnotation, addAnnotation, addMarkerAnnotation, addMarkerAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, getAnnotation, getAnnotationByClass, getAnnotationByName, isAnnotationPresent, isAnnotationPresent, setAnnotation

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

getNameAsString, setName

Methods inherited from interface com.github.javaparser.HasParentNode

getAncestorOfType, setAsParentNodeOf, setAsParentNodeOf

Constructor Detail

PackageDeclaration

public PackageDeclaration()

PackageDeclaration

public PackageDeclaration(Name name)

PackageDeclaration

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

PackageDeclaration

public PackageDeclaration(Range range,
                          NodeList<AnnotationExpr> annotations,
                          Name 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 Name getName()

Return the name expression of the package.

Specified by:

getName in interface NodeWithName<PackageDeclaration>

Returns:

the name of the package

setAnnotations

public PackageDeclaration setAnnotations(NodeList<AnnotationExpr> annotations)

Specified by:

setAnnotations in interface NodeWithAnnotations<PackageDeclaration>

Parameters:

annotations - the annotations to set

setName

public PackageDeclaration setName(Name name)

Sets the name of this package declaration.

Specified by:

setName in interface NodeWithName<PackageDeclaration>

Parameters:

name - the name to set

getNodeLists

public List<NodeList<?>> getNodeLists()

Description copied from class: Node

The list of NodeLists owned by this node.

Overrides:

getNodeLists in class Node