Top Description Fields Constructors Methods
com.github.javaparser.ast

public Class PackageDeclaration

extends Node
implements NodeWithAnnotations<PackageDeclaration>, NodeWithName<PackageDeclaration>
Class Inheritance
All Implemented Interfaces
com.github.javaparser.ast.nodeTypes.NodeWithName, com.github.javaparser.ast.nodeTypes.NodeWithAnnotations
Imports
com.github.javaparser.ast.expr.AnnotationExpr, .Name, com.github.javaparser.ast.nodeTypes.NodeWithAnnotations, .NodeWithName, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.visitor.GenericVisitor, .VoidVisitor, .CloneVisitor, com.github.javaparser.metamodel.PackageDeclarationMetaModel, .JavaParserMetaModel, com.github.javaparser.TokenRange, com.github.javaparser.ast.Node, .Generated
A package declaration.
package com.github.javaparser.ast;
@Wonderful package anything.can.be.annotated.nowadays;
Author
Julio Vilmar Gesser

Field Summary

Modifier and TypeField and Description
private NodeList<AnnotationExpr>
annotations

private Name
name

Inherited from com.github.javaparser.ast.Node:
ABSOLUTE_BEGIN_LINEABSOLUTE_END_LINENODE_BY_BEGIN_POSITIONprettyPrinterNoCommentsConfigurationSYMBOL_RESOLVER_KEY

Constructor Summary

AccessConstructor and Description
public
PackageDeclaration()

public
PackageDeclaration(Name name)

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

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

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

Method Summary

Modifier and TypeMethod and Description
public <R, A> R
accept(final GenericVisitor<R, A>
the visitor implementation
v, final A
the argument passed to the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public <A> void
accept(final VoidVisitor<A>
the visitor implementation
v, final A
any value relevant for the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public PackageDeclaration
clone()

Overrides com.github.javaparser.ast.Node.clone.

Creates and returns a copy of this object.
public NodeList<AnnotationExpr>

Returns:

list of annotations or null
getAnnotations()

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.getAnnotations.

Retrieves the list of annotations declared before the package declaration.
public PackageDeclarationMetaModel
getMetaModel()

Overrides com.github.javaparser.ast.Node.getMetaModel.

public Name

Returns:

the name of the package
getName()

Implements com.github.javaparser.ast.nodeTypes.NodeWithName.getName.

Return the name expression of the package.
public boolean
remove(Node node)

Overrides com.github.javaparser.ast.Node.remove.

public boolean
replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.Node.replace.

public PackageDeclaration
setAnnotations(final NodeList<AnnotationExpr>
the annotations to set
annotations)

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.setAnnotations.

public PackageDeclaration
setName(final Name
the name to set
name)

Implements com.github.javaparser.ast.nodeTypes.NodeWithName.setName.

Sets the name of this package declaration.
Inherited from com.github.javaparser.ast.Node:
addOrphanCommentcontainsDatacustomInitializationequalsfindAllfindAllfindCompilationUnitfindFirstfindFirstfindFirstfindRootNodegetAllContainedCommentsgetChildNodesgetChildNodesByTypegetCommentgetDatagetDataKeysgetNodesByTypegetOrphanCommentsgetParentNodegetParentNodeForChildrengetParsedgetRangegetSymbolResolvergetTokenRangegetToStringPrettyPrinterConfigurationhashCodeisAncestorOfisRegisterednotifyPropertyChangeregisterregisterregisterForSubtreeremoveremoveCommentremoveDataremoveForcedremoveOrphanCommentreplacesetAsParentNodeOfsetAsParentNodeOfsetBlockCommentsetCommentsetDatasetLineCommentsetParentNodesetParsedsetRangesetTokenRangesetToStringPrettyPrinterConfigurationstreamstreamtoStringtoStringtryAddImportToParentCompilationUnitunregisterwalkwalkwalk

Field Detail

annotationsback to summary
private NodeList<AnnotationExpr> annotations
nameback to summary
private Name name

Constructor Detail

PackageDeclarationback to summary
public PackageDeclaration()
PackageDeclarationback to summary
public PackageDeclaration(Name name)
PackageDeclarationback to summary
public PackageDeclaration(NodeList<AnnotationExpr> annotations, Name name)
Annotations
@AllFieldsConstructor
PackageDeclarationback to summary
public PackageDeclaration(TokenRange tokenRange, NodeList<AnnotationExpr> annotations, Name name)

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

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator

Method Detail

acceptback to summary
public <R, A> R accept(final GenericVisitor<R, A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<R>
the type of the return value of the visitor
<A>
the type the user argument passed to the visitor
v:GenericVisitor<R, A>

the visitor implementation

arg:A

the argument passed to the visitor (of type A)

Returns:R

the result of the visit (of type R)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
acceptback to summary
public <A> void accept(final VoidVisitor<A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<A>
the type the argument passed for the visitor
v:VoidVisitor<A>

the visitor implementation

arg:A

any value relevant for the visitor (of type A)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
cloneback to summary
public PackageDeclaration clone()

Overrides com.github.javaparser.ast.Node.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression: 

x.clone() != x
will be true, and that the expression: 
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that: 
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:PackageDeclaration

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getAnnotationsback to summary
public NodeList<AnnotationExpr> getAnnotations()

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.getAnnotations.

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

Returns:NodeList<AnnotationExpr>

list of annotations or null

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getMetaModelback to summary
public PackageDeclarationMetaModel getMetaModel()

Overrides com.github.javaparser.ast.Node.getMetaModel.

Returns:PackageDeclarationMetaModel

Doc from com.github.javaparser.ast.Node.getMetaModel.

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
getNameback to summary
public Name getName()

Implements com.github.javaparser.ast.nodeTypes.NodeWithName.getName.

Return the name expression of the package.

Returns:Name

the name of the package

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
removeback to summary
public boolean remove(Node node)

Overrides com.github.javaparser.ast.Node.remove.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator
replaceback to summary
public boolean replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.Node.replace.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.ReplaceMethodGenerator
setAnnotationsback to summary
public PackageDeclaration setAnnotations(final NodeList<AnnotationExpr> annotations)

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.setAnnotations.

Parameters
annotations:NodeList<AnnotationExpr>

the annotations to set

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setNameback to summary
public PackageDeclaration setName(final Name name)

Implements com.github.javaparser.ast.nodeTypes.NodeWithName.setName.

Sets the name of this package declaration.

Parameters
name:Name

the name to set

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator