Package 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>, NodeWithRange<Node>, NodeWithTokenRange<Node>, Observable, Visitable, HasParentNode<Node>, Cloneable

public 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.BreadthFirstIterator, Node.DirectChildrenIterator, Node.ObserverRegistrationMode, Node.ParentsVisitor, Node.Parsedness, Node.PostOrderIterator, Node.PreOrderIterator, Node.TreeTraversal

Field Summary

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

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, LINE_SEPARATOR_KEY, NODE_BY_BEGIN_POSITION, PHANTOM_KEY, prettyPrinterNoCommentsConfiguration, PRINTER_KEY, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Constructor	Description
PackageDeclaration()
PackageDeclaration(Name name)
PackageDeclaration(NodeList<AnnotationExpr> annotations, Name name)
PackageDeclaration(TokenRange tokenRange, NodeList<AnnotationExpr> annotations, Name name)	This constructor is used by the parser and is considered private.

Method Summary

Modifier and Type	Method	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.
PackageDeclaration	clone()
NodeList<AnnotationExpr>	getAnnotations()	Retrieves the list of annotations declared before the package declaration.
PackageDeclarationMetaModel	getMetaModel()
Name	getName()	Return the name expression of the package.
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
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, containsData, createDefaultPrinter, createDefaultPrinter, customInitialization, equals, findAll, findAll, findAll, findByRange, findCompilationUnit, findData, findFirst, findFirst, findFirst, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getDataKeys, getDefaultPrinterConfiguration, getLineEndingStyle, getLineEndingStyleOrDefault, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getPrinter, getPrinter, getRange, getSymbolResolver, getTokenRange, hashCode, hasScope, isAncestorOf, isPhantom, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, stream, stream, toString, toString, tryAddImportToParentCompilationUnit, unregister, walk, walk, walk

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.javaparser.HasParentNode

findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf

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

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

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

getNameAsString, setName

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

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Constructor Detail

PackageDeclaration

public PackageDeclaration()

PackageDeclaration

public PackageDeclaration(Name name)

PackageDeclaration

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

PackageDeclaration

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

This constructor is used by the parser and is considered private.

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

remove

public boolean remove(Node node)

Overrides:

remove in class Node

clone

public PackageDeclaration clone()

Overrides:

clone in class Node

getMetaModel

public PackageDeclarationMetaModel getMetaModel()

Overrides:

getMetaModel in class Node

Returns:

get JavaParser specific node introspection information.

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class Node