CompilationUnit (RSTALanguageSupport 3.3.0 API)

java.lang.Object
- org.fife.rsta.ac.java.rjc.ast.CompilationUnit

All Implemented Interfaces:: ASTNode, TypeDeclarationContainer

public class CompilationUnit
extends java.lang.Object
implements TypeDeclarationContainer

A CompilationUnit is the root node of an AST for a Java source file.

 CompilationUnit:
    [[Annotations] 'package' QualifiedIdentifier ';' ] {ImportDeclaration} {TypeDeclaration}

Constructor Summary

Constructors
Constructor and Description

CompilationUnit(java.lang.String name)

Constructors
Constructor and Description
`CompilationUnit(java.lang.String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addImportDeclaration(ImportDeclaration dec)` Adds an import declaration to this compilation unit.
`void`	`addParserNotice(ParserNotice notice)` Adds a parser notice to this compilation unit.
`void`	`addParserNotice(Token t, java.lang.String msg)` Shorthand for "`addParserNotice(new ParserNotice(t, msg))`".
`void`	`addTypeDeclaration(TypeDeclaration typeDec)` Adds a type declaration to this container.
`int`	`getAnnotationCount()`
`java.util.Iterator<Annotation>`	`getAnnotationIterator()`
`TypeDeclaration`	`getDeepestTypeDeclarationAtOffset(int offs)` Returns the deepest-nested type declaration that contains a given offset.
`java.awt.Point`	`getEnclosingMethodRange(int offs)` TODO: Return range for more instances than just class methods.
`int`	`getImportCount()`
`java.util.Iterator<ImportDeclaration>`	`getImportIterator()`
`java.util.List<ImportDeclaration>`	`getImports()` Returns the import declarations of this compilation unit.
`java.lang.String`	`getName()` Returns the "name" of this node.
`int`	`getNameEndOffset()` Returns the end offset of the "name" of this node.
`int`	`getNameStartOffset()` Returns the start offset of the "name" of this node.
`Package`	`getPackage()` Returns the package of this compilation unit.
`java.lang.String`	`getPackageName()` Returns the fully-qualified package name of this compilation unit.
`ParserNotice`	`getParserNotice(int index)` Returns the specified parser notice.
`int`	`getParserNoticeCount()`
`TypeDeclaration`	`getTypeDeclaration(int index)` Returns the specified type declaration.
`TypeDeclaration`	`getTypeDeclarationAtOffset(int offs)` Returns the type declaration in this file that contains the specified offset.
`int`	`getTypeDeclarationCount()`
`java.util.Iterator<TypeDeclaration>`	`getTypeDeclarationIterator()`
`void`	`setDeclarationEndOffset(Offset end)`
`protected void`	`setDeclarationOffsets(Offset start, Offset end)` Sets the start and end offsets of this node.
`void`	`setPackage(Package pkg)`
`java.lang.String`	`toString()` Returns the name of this node (e.g.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CompilationUnit
```
public CompilationUnit(java.lang.String name)
```
- Method Detail
  - addImportDeclaration
```
public void addImportDeclaration(ImportDeclaration dec)
```
    Adds an import declaration to this compilation unit.
    
    Parameters:
    
    dec - The import declaration.
    
    See Also:
    
    getImports()
  - addParserNotice
```
public void addParserNotice(Token t,
                            java.lang.String msg)
```
    Shorthand for "addParserNotice(new ParserNotice(t, msg))".
    
    Parameters:
    
    t - The token to add a parser notice for.
    
    msg - The message of the parser notice.
    
    See Also:
    
    addParserNotice(ParserNotice)
  - addParserNotice
```
public void addParserNotice(ParserNotice notice)
```
    Adds a parser notice to this compilation unit.
    
    Parameters:
    
    notice - The notice to add.
    
    See Also:
    
    addParserNotice(Token, String)
  - addTypeDeclaration
```
public void addTypeDeclaration(TypeDeclaration typeDec)
```
    Description copied from interface: TypeDeclarationContainer
    
    Adds a type declaration to this container.
    
    Specified by:
    
    addTypeDeclaration in interface TypeDeclarationContainer
    
    Parameters:
    
    typeDec - The new type declaration.
  - getAnnotationCount
```
public int getAnnotationCount()
```
  - getAnnotationIterator
```
public java.util.Iterator<Annotation> getAnnotationIterator()
```
  - getDeepestTypeDeclarationAtOffset
```
public TypeDeclaration getDeepestTypeDeclarationAtOffset(int offs)
```
    Returns the deepest-nested type declaration that contains a given offset.
    
    Parameters:
    
    offs - The offset.
    
    Returns:
    
    The deepest-nested type declaration containing the offset, or null if the offset is outside any type declaration (such as in the import statements, etc.).
    
    See Also:
    
    getTypeDeclarationAtOffset(int)
  - getEnclosingMethodRange
```
public java.awt.Point getEnclosingMethodRange(int offs)
```
    TODO: Return range for more instances than just class methods. Also handle child TypeDeclarations.
    
    Parameters:
    
    offs - The offset to check.
    
    Returns:
    
    The starting and ending offset of the enclosing method range.
  - getImportCount
```
public int getImportCount()
```
  - getImports
```
public java.util.List<ImportDeclaration> getImports()
```
    Returns the import declarations of this compilation unit. This is a copy of the list of imports, but the actual individual ImportDeclarations are not copies, so modifying them will modify this compilation unit!
    
    Returns:
    
    A list or imports, or an empty list if there are none.
  - getImportIterator
```
public java.util.Iterator<ImportDeclaration> getImportIterator()
```
  - getPackage
```
public Package getPackage()
```
    Returns the package of this compilation unit.
    
    Returns:
    
    The package of this compilation unit, or null if this compilation unit is not in a package.
    
    See Also:
    
    getPackageName()
  - getPackageName
```
public java.lang.String getPackageName()
```
    Returns the fully-qualified package name of this compilation unit.
    
    Returns:
    
    The package name, or null if this compilation unit is not in a package (in the default package).
    
    See Also:
    
    getPackage()
  - getParserNotice
```
public ParserNotice getParserNotice(int index)
```
    Returns the specified parser notice.
    
    Parameters:
    
    index - The index of the parser notice.
    
    Returns:
    
    The parser notice.
    
    See Also:
    
    getParserNoticeCount()
  - getParserNoticeCount
```
public int getParserNoticeCount()
```
  - getTypeDeclaration
```
public TypeDeclaration getTypeDeclaration(int index)
```
    Returns the specified type declaration.
    
    Parameters:
    
    index - The index of the type declaration.
    
    Returns:
    
    The type declaration.
    
    See Also:
    
    getTypeDeclarationCount()
  - getTypeDeclarationAtOffset
```
public TypeDeclaration getTypeDeclarationAtOffset(int offs)
```
    Returns the type declaration in this file that contains the specified offset.
    
    Parameters:
    
    offs - The offset.
    
    Returns:
    
    The type declaration, or null if the offset is outside any type declaration.
    
    See Also:
    
    getDeepestTypeDeclarationAtOffset(int)
  - getTypeDeclarationCount
```
public int getTypeDeclarationCount()
```
  - getTypeDeclarationIterator
```
public java.util.Iterator<TypeDeclaration> getTypeDeclarationIterator()
```
  - setPackage
```
public void setPackage(Package pkg)
```
  - getName
```
public java.lang.String getName()
```
    Returns the "name" of this node. This will be the name of the method, the name of the member or local variable, etc. For CodeBlocks it will be CodeBlock.NAME.
    Note that this may not be unique. For example, a class with an overloaded method will have multiple methods with the same "name," just with different signatures.
    
    Specified by:
    
    getName in interface ASTNode
    
    Returns:
    
    The "name" of this node.
  - getNameEndOffset
```
public int getNameEndOffset()
```
    Returns the end offset of the "name" of this node.
    
    Specified by:
    
    getNameEndOffset in interface ASTNode
    
    Returns:
    
    The end offset.
  - getNameStartOffset
```
public int getNameStartOffset()
```
    Returns the start offset of the "name" of this node.
    
    Specified by:
    
    getNameStartOffset in interface ASTNode
    
    Returns:
    
    The start offset.
  - setDeclarationEndOffset
```
public void setDeclarationEndOffset(Offset end)
```
  - setDeclarationOffsets
```
protected void setDeclarationOffsets(Offset start,
                                     Offset end)
```
    Sets the start and end offsets of this node.
    
    Parameters:
    
    start - The start offset.
    
    end - The end offset.
  - toString
```
public java.lang.String toString()
```
    Returns the name of this node (e.g. the value of getName()). Subclasses can override this method if appropriate.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this node.

Class CompilationUnit

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompilationUnit

Method Detail

addImportDeclaration

addParserNotice

addParserNotice

addTypeDeclaration

getAnnotationCount

getAnnotationIterator

getDeepestTypeDeclarationAtOffset

getEnclosingMethodRange

getImportCount

getImports

getImportIterator

getPackage

getPackageName

getParserNotice

getParserNoticeCount

getTypeDeclaration

getTypeDeclarationAtOffset

getTypeDeclarationCount

getTypeDeclarationIterator

setPackage

getName

getNameEndOffset

getNameStartOffset

setDeclarationEndOffset

setDeclarationOffsets

toString