Java Doc for CompilationUnit.java in  » IDE-Eclipse » jdt » org » eclipse » jdt » core » dom » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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 | ; }
 

 CompilationUnit:
 [ PackageDeclaration ]
 { ImportDeclaration }
 { TypeDeclaration | EnumDeclaration | AnnotationTypeDeclaration | ; }
 

N.B.

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 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.

N.B. This constructor is package-private; all subclasses must be declared in the same package; clients are unable to declare additional subclasses.

The following table indicates the expected node type for the various different kinds of bindings:

• package - a PackageDeclaration
• class or interface - a TypeDeclaration or a AnonymousClassDeclaration (for anonymous classes)
• primitive type - none
• array type - none
• field - a VariableDeclarationFragment in a FieldDeclaration
• local variable - a SingleVariableDeclaration, or a VariableDeclarationFragment in a VariableDeclarationStatement or VariableDeclarationExpression
• method - a MethodDeclaration
• constructor - a MethodDeclaration
• annotation type - an AnnotationTypeDeclaration
• annotation type member - an AnnotationTypeMemberDeclaration
• enum type - an EnumDeclaration
• enum constant - an EnumConstantDeclaration
• type variable - a TypeParameter
• capture binding - none
• annotation binding - an Annotation
• member value pair binding - an 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.

The following table indicates the expected node type for the various different kinds of binding keys:

• package - a PackageDeclaration
• class or interface - a TypeDeclaration or a AnonymousClassDeclaration (for anonymous classes)
• primitive type - none
• array type - none
• field - a VariableDeclarationFragment in a FieldDeclaration
• local variable - a SingleVariableDeclaration, or a VariableDeclarationFragment in a VariableDeclarationStatement or VariableDeclarationExpression
• method - a MethodDeclaration
• constructor - a MethodDeclaration
• annotation type - an AnnotationTypeDeclaration
• annotation type member - an AnnotationTypeMemberDeclaration
• enum type - an EnumDeclaration
• enum constant - an EnumConstantDeclaration
• type variable - a TypeParameter
• capture binding - none

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 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 ASTNode.getParent getParent() of a doc comment associated with a body declaration is the body declaration node; for these comment nodes ASTNode.getRoot 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, ASTNode.getParent getParent() will return null, and ASTNode.getRoot 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 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 ASTNode.accept(ASTVisitor) accept on each element.

Clients cannot modify the resulting list.

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.

Simple clients that do little more than log the messages or display them to the user should probably call getMessages instead.

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 affect of all those changes.

• the node belongs to a different AST
• the node already has a parent

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.