Package org.eclipse.jdt.core.dom
Class PackageDeclaration
- java.lang.Object
-
- org.eclipse.jdt.core.dom.ASTNode
-
- org.eclipse.jdt.core.dom.PackageDeclaration
-
public class PackageDeclaration extends ASTNode
Package declaration AST node type.PackageDeclaration: [ Javadoc ] { Annotation } package Name ;
Note that the standard AST parser only recognizes a Javadoc comment immediately preceding the package declaration when it occurs in the specialpackage-info.java
compilation unit (JLS3 7.4.1.1). The Javadoc comment in that file contains the package description.- Since:
- 2.0
- Restriction:
- This class is not intended to be instantiated by clients.
-
-
Field Summary
Fields Modifier and Type Field Description static ChildListPropertyDescriptor
ANNOTATIONS_PROPERTY
The "annotations" structural property of this node type (element type:Annotation
) (added in JLS3 API).static ChildPropertyDescriptor
JAVADOC_PROPERTY
The "javadoc" structural property of this node type (child type:Javadoc
) (added in JLS3 API).static ChildPropertyDescriptor
NAME_PROPERTY
The "name" structural property of this node type (child type:Name
).-
Fields inherited from class org.eclipse.jdt.core.dom.ASTNode
ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BLOCK_COMMENT, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, CREATION_REFERENCE, DIMENSION, DO_STATEMENT, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPORTS_DIRECTIVE, EXPRESSION_METHOD_REFERENCE, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, INTERSECTION_TYPE, JAVADOC, LABELED_STATEMENT, LAMBDA_EXPRESSION, LINE_COMMENT, MALFORMED, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, MODULE_DECLARATION, MODULE_MODIFIER, NAME_QUALIFIED_TYPE, NORMAL_ANNOTATION, NULL_LITERAL, NUMBER_LITERAL, OPENS_DIRECTIVE, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, PROVIDES_DIRECTIVE, QUALIFIED_NAME, QUALIFIED_TYPE, RECORD_DECLARATION, RECOVERED, REQUIRES_DIRECTIVE, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SUPER_METHOD_REFERENCE, SWITCH_CASE, SWITCH_EXPRESSION, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TEXT_BLOCK, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_METHOD_REFERENCE, TYPE_PARAMETER, UNION_TYPE, USES_DIRECTIVE, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE, YIELD_STATEMENT
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List
annotations()
Returns the live ordered list of annotations of this package declaration (added in JLS3 API).Javadoc
getJavadoc()
Returns the doc comment node (added in JLS3 API).Name
getName()
Returns the package name of this package declaration.static List
propertyDescriptors(int apiLevel)
Returns a list of structural property descriptors for this node type.IPackageBinding
resolveBinding()
Resolves and returns the binding for the package declared in this package declaration.void
setJavadoc(Javadoc docComment)
Sets or clears the doc comment node (added in JLS3 API).void
setName(Name name)
Sets the package name of this package declaration to the given name.-
Methods inherited from class org.eclipse.jdt.core.dom.ASTNode
accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, hashCode, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString
-
-
-
-
Field Detail
-
JAVADOC_PROPERTY
public static final ChildPropertyDescriptor JAVADOC_PROPERTY
The "javadoc" structural property of this node type (child type:Javadoc
) (added in JLS3 API).- Since:
- 3.0
-
ANNOTATIONS_PROPERTY
public static final ChildListPropertyDescriptor ANNOTATIONS_PROPERTY
The "annotations" structural property of this node type (element type:Annotation
) (added in JLS3 API).- Since:
- 3.1
-
NAME_PROPERTY
public static final ChildPropertyDescriptor NAME_PROPERTY
The "name" structural property of this node type (child type:Name
).- Since:
- 3.0
-
-
Method Detail
-
propertyDescriptors
public static List propertyDescriptors(int apiLevel)
Returns a list of structural property descriptors for this node type. Clients must not modify the result.- Parameters:
apiLevel
- the API level; one of theAST.JLS*
constants- Returns:
- a list of property descriptors (element type:
StructuralPropertyDescriptor
) - Since:
- 3.0
-
annotations
public List annotations()
Returns the live ordered list of annotations of this package declaration (added in JLS3 API).- Returns:
- the live list of annotations
(element type:
Annotation
) - Throws:
UnsupportedOperationException
- if this operation is used in a JLS2 AST- Since:
- 3.1
-
getJavadoc
public Javadoc getJavadoc()
Returns the doc comment node (added in JLS3 API).- Returns:
- the doc comment node, or
null
if none - Throws:
UnsupportedOperationException
- if this operation is used in a JLS2 AST- Since:
- 3.0
-
setJavadoc
public void setJavadoc(Javadoc docComment)
Sets or clears the doc comment node (added in JLS3 API).- Parameters:
docComment
- the doc comment node, ornull
if none- Throws:
IllegalArgumentException
- if the doc comment string is invalidUnsupportedOperationException
- if this operation is used in a JLS2 AST- Since:
- 3.0
-
getName
public Name getName()
Returns the package name of this package declaration.- Returns:
- the package name node
-
setName
public void setName(Name name)
Sets the package name of this package declaration to the given name.- Parameters:
name
- the new package name- Throws:
IllegalArgumentException
- if`:- the node belongs to a different AST
- the node already has a parent
-
resolveBinding
public IPackageBinding resolveBinding()
Resolves and returns the binding for the package declared in this package declaration.Note that bindings are generally unavailable unless requested when the AST is being built.
- Returns:
- the binding, or
null
if the binding cannot be resolved
-
-