public class CompilationUnit extends ASTNode
The source range for this type of node is ordinarily the entire source file, including leading and trailing whitespace and comments.
CompilationUnit: [ PackageDeclaration ] { ImportDeclaration } { TypeDeclaration | EnumDeclaration | AnnotationTypeDeclaration | ; }
Modifier and Type | Field and Description |
---|---|
static ChildListPropertyDescriptor |
IMPORTS_PROPERTY
The "imports" structural property of this node type (element type:
ImportDeclaration ). |
static ChildPropertyDescriptor |
PACKAGE_PROPERTY
The "package" structural property of this node type (child type:
PackageDeclaration ). |
static ChildListPropertyDescriptor |
TYPES_PROPERTY
The "types" structural property of this node type (element type:
AbstractTypeDeclaration ). |
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, 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, NAME_QUALIFIED_TYPE, NORMAL_ANNOTATION, NULL_LITERAL, NUMBER_LITERAL, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, QUALIFIED_NAME, QUALIFIED_TYPE, RECOVERED, 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_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_METHOD_REFERENCE, TYPE_PARAMETER, UNION_TYPE, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE
Modifier and Type | Method and Description |
---|---|
ASTNode |
findDeclaringNode(IBinding binding)
Finds the corresponding AST node in the given compilation unit from
which the given binding originated.
|
ASTNode |
findDeclaringNode(String key)
Finds the corresponding AST node in the given compilation unit from
which the binding with the given key originated.
|
int |
firstLeadingCommentIndex(ASTNode node)
Return the index in the whole comments list
getCommentList()
of the first leading comments associated with the given node. |
int |
getColumnNumber(int position)
Returns the column number corresponding to the given source character
position in the original source string.
|
List |
getCommentList()
Returns a list of the comments encountered while parsing
this compilation unit.
|
int |
getExtendedLength(ASTNode node)
Returns the extended source length of the given node.
|
int |
getExtendedStartPosition(ASTNode node)
Returns the extended start position of the given node.
|
IJavaElement |
getJavaElement()
The Java element (an
org.eclipse.jdt.core.ICompilationUnit or an org.eclipse.jdt.core.IClassFile )
this compilation unit was created from, or null if it was not created from a Java element. |
int |
getLineNumber(int position)
Returns the line number corresponding to the given source character
position in the original source string.
|
Message[] |
getMessages()
Returns the list of messages reported by the compiler during the parsing
or the type checking of this compilation unit.
|
PackageDeclaration |
getPackage()
Returns the node for the package declaration of this compilation
unit, or
null if this compilation unit is in the
default package. |
int |
getPosition(int line,
int column)
Given a line number and column number, returns the corresponding
position in the original source string.
|
IProblem[] |
getProblems()
Returns the list of detailed problem reports noted by the compiler
during the parsing or the type checking of this compilation unit.
|
Object |
getStatementsRecoveryData()
Internal method
This method return internal data used to perform statements recovery.
|
ITypeRoot |
getTypeRoot()
The Java type root (a
compilation unit or a class file )
this compilation unit was created from, or null if it was not created from a Java type root. |
List |
imports()
Returns the live list of nodes for the import declarations of this
compilation unit, in order of appearance.
|
int |
lastTrailingCommentIndex(ASTNode node)
Return the index in the whole comments list
getCommentList()
of the last trailing comments associated with the given node. |
int |
lineNumber(int position)
Deprecated.
Use getLineNumber(int) instead. Be careful to handle the negative values.
|
static List |
propertyDescriptors(int apiLevel)
Returns a list of structural property descriptors for this node type.
|
void |
recordModifications()
Enables the recording of changes to this compilation
unit and its descendants.
|
TextEdit |
rewrite(IDocument document,
Map options)
Converts all modifications recorded for this compilation
unit into an object representing the corresponding text
edits to the given document containing the original source
code for this compilation unit.
|
void |
setPackage(PackageDeclaration pkgDecl)
Sets or clears the package declaration of this compilation unit
node to the given package declaration node.
|
List |
types()
Returns the live list of nodes for the top-level type declarations of this
compilation unit, in order of appearance.
|
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
public static final ChildListPropertyDescriptor IMPORTS_PROPERTY
ImportDeclaration
).public static final ChildPropertyDescriptor PACKAGE_PROPERTY
PackageDeclaration
).public static final ChildListPropertyDescriptor TYPES_PROPERTY
AbstractTypeDeclaration
).public static List propertyDescriptors(int apiLevel)
apiLevel
- the API level; one of the
AST.JLS*
constantsStructuralPropertyDescriptor
)public int getColumnNumber(int position)
-1
if it is beyond the valid range or -2
if the column number information is unknown.position
- a 0-based character position, possibly
negative or out of range-1
if the character
position does not correspond to a source line in the original
source file or -2
if column number information is unknown for this
compilation unitASTParser
public ASTNode findDeclaringNode(IBinding binding)
null
if the
binding does not correspond to any node in this compilation unit.
This method always returns null
if bindings were not requested
when this AST was built.
The following table indicates the expected node type for the various different kinds of bindings:
PackageDeclaration
TypeDeclaration
or a
AnonymousClassDeclaration
(for anonymous classes)VariableDeclarationFragment
in a
FieldDeclaration
SingleVariableDeclaration
, or
a VariableDeclarationFragment
in a
VariableDeclarationStatement
or
VariableDeclarationExpression
MethodDeclaration
MethodDeclaration
AnnotationTypeDeclaration
AnnotationTypeMemberDeclaration
EnumDeclaration
EnumConstantDeclaration
TypeParameter
Annotation
MemberValuePair
,
or null
if it represents a default value or a single member value
Each call to ASTParser.createAST(org.eclipse.core.runtime.IProgressMonitor)
with a request for bindings
gives rise to separate universe of binding objects. This method always returns
null
when the binding object comes from a different AST.
Use findDeclaringNode(binding.getKey())
when the binding comes
from a different AST.
binding
- the bindingnull
if the binding does not correspond to a node in this
compilation unit or if bindings were not requested when this AST was builtfindDeclaringNode(String)
public ASTNode findDeclaringNode(String key)
null
if the corresponding node cannot be determined.
This method always returns null
if bindings were not requested
when this AST was built.
The following table indicates the expected node type for the various different kinds of binding keys:
PackageDeclaration
TypeDeclaration
or a
AnonymousClassDeclaration
(for anonymous classes)VariableDeclarationFragment
in a
FieldDeclaration
SingleVariableDeclaration
, or
a VariableDeclarationFragment
in a
VariableDeclarationStatement
or
VariableDeclarationExpression
MethodDeclaration
MethodDeclaration
AnnotationTypeDeclaration
AnnotationTypeMemberDeclaration
EnumDeclaration
EnumConstantDeclaration
TypeParameter
key
- the binding key, or null
null
if the key is null
or if the key does not correspond to a node in this compilation unit
or if bindings were not requested when this AST was builtIBinding.getKey()
public List getCommentList()
Since the Java language allows comments to appear most anywhere
in the source text, it is problematic to locate comments in relation
to the structure of an AST. The one exception is doc comments
which, by convention, immediately precede type, field, and
method declarations; these comments are located in the AST
by BodyDeclaration.getJavadoc
.
Other comments do not show up in the AST. The table of comments
is provided for clients that need to find the source ranges of
all comments in the original source string. It includes entries
for comments of all kinds (line, block, and doc), arranged in order
of increasing source position.
Note on comment parenting: The getParent()
of a doc comment associated with a body declaration is the body
declaration node; for these comment nodes
getRoot()
will return the compilation unit
(assuming an unmodified AST) reflecting the fact that these nodes
are property located in the AST for the compilation unit.
However, for other comment nodes, getParent()
will return null
, and getRoot()
will return the comment node itself, indicating that these comment nodes
are not directly connected to the AST for the compilation unit. The
Comment.getAlternateRoot
method provides a way to navigate from a comment to its compilation
unit.
A note on visitors: The only comment nodes that will be visited when
visiting a compilation unit are the doc comments parented by body
declarations. To visit all comments in normal reading order, iterate
over the comment table and call accept
on each element.
Clients cannot modify the resulting list.
public int getExtendedLength(ASTNode node)
ASTNode.getStartPosition()
and ASTNode.getLength()
,
the extended source range may include comments and whitespace
immediately before or after the normal source range for the node.node
- the node0
if no source position information is recorded for this nodegetExtendedStartPosition(ASTNode)
public int getExtendedStartPosition(ASTNode node)
ASTNode.getStartPosition()
and ASTNode.getLength()
,
the extended source range may include comments and whitespace
immediately before or after the normal source range for the node.node
- the node-1
if no source position information is recorded for this nodegetExtendedLength(ASTNode)
public IJavaElement getJavaElement()
org.eclipse.jdt.core.ICompilationUnit
or an org.eclipse.jdt.core.IClassFile
)
this compilation unit was created from, or null
if it was not created from a Java element.null
if nonegetTypeRoot()
public Message[] getMessages()
This list of messages is suitable for simple clients that do little
more than log the messages or display them to the user. Clients that
need further details should call getProblems
to get
compiler problem objects.
getProblems()
,
ASTParser
public PackageDeclaration getPackage()
null
if this compilation unit is in the
default package.null
if nonepublic int getPosition(int line, int column)
line
is greater than the actual number lines in the unit.
Returns -1 if column
is less than 0,
or the position of the last character of the line if column
is beyond the legal range, or the given line number is less than one.line
- the one-based line numbercolumn
- the zero-based column number-2
if line/column number information is not known
for this compilation unit or -1
the inputs are not validpublic IProblem[] getProblems()
Simple clients that do little more than log the messages or display
them to the user should probably call getMessages
instead.
getMessages()
,
ASTParser
public Object getStatementsRecoveryData()
public ITypeRoot getTypeRoot()
compilation unit
or a class file
)
this compilation unit was created from, or null
if it was not created from a Java type root.null
if nonepublic List imports()
ImportDeclaration
)public int firstLeadingCommentIndex(ASTNode node)
getCommentList()
of the first leading comments associated with the given node.node
- the nodepublic int lastTrailingCommentIndex(ASTNode node)
getCommentList()
of the last trailing comments associated with the given node.node
- the nodepublic int lineNumber(int position)
class A\n{\n}
has 3 lines
corresponding to inclusive character ranges [0,7], [8,9], and [10,10].
Returns 1 for a character position that does not correspond to any
source line, or if no line number information is available for this
compilation unit.position
- a 0-based character position, possibly
negative or out of range1
if the character
position does not correspond to a source line in the original
source file or if line number information is not known for this
compilation unitASTParser
,
getLineNumber(int)
public int getLineNumber(int position)
class A\n{\n}
has 3 lines
corresponding to inclusive character ranges [0,7], [8,9], and [10,10].
Returns -1 for a character position that does not correspond to any
source line, or -2 if no line number information is available for this
compilation unit.position
- a 0-based character position, possibly
negative or out of range-1
if the character
position does not correspond to a source line in the original
source file or -2
if line number information is not known for this
compilation unitASTParser
public void recordModifications()
ASTParser
and still be in
its original state. Once recording is on,
arbitrary changes to the subtree rooted at this compilation
unit are recorded internally. Once the modification has
been completed, call rewrite(IDocument, Map)
to get an object
representing the corresponding edits to the original
source code string.
Note that this way of manipulating an AST only allows a single line of modifications,
and it lacks important functionality like
string placeholders
and support for
copying
nodes including comments and formatting.
To future-proof your code, consider using an external ASTRewrite
instead,
which doesn't suffer from these limitations and allows to modify an AST in a non-destructive way.
IllegalArgumentException
- if this compilation unit is
marked as unmodifiable, or if this compilation unit has already
been tampered with, or recording has already been enabledASTRewrite
public TextEdit rewrite(IDocument document, Map options)
The compilation unit must have been created by
ASTParser
from the source code string in the
given document, and recording must have been turned
on with a prior call to recordModifications()
while the AST was still in its original state.
Calling this methods does not discard the modifications on record. Subsequence modifications made to the AST are added to the ones already on record. If this method is called again later, the resulting text edit object will accurately reflect the net cumulative effect of all those changes.
document
- original document containing source code
for this compilation unitoptions
- the table of formatter options
(key type: String
; value type: String
);
or null
to use the standard global options
JavaCore.getOptions()
.IllegalArgumentException
- if the document passed is
null
or does not correspond to this ASTIllegalStateException
- if recordModifications
was not called to enable recordingrecordModifications()
public void setPackage(PackageDeclaration pkgDecl)
pkgDecl
- the new package declaration node, or
null
if this compilation unit does not have a package
declaration (that is in the default package)IllegalArgumentException
- if:
public List types()
Note that in JLS3, the types may include both enum declarations
and annotation type declarations introduced in J2SE 5.
For JLS2, the elements are always TypeDeclaration
.
AbstractTypeDeclaration
)
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.