de.uka.ilkd.key.java

Class CompilationUnit

java.lang.Object

de.uka.ilkd.key.java.JavaSourceElement

de.uka.ilkd.key.java.JavaProgramElement

de.uka.ilkd.key.java.JavaNonTerminalProgramElement

de.uka.ilkd.key.java.CompilationUnit

All Implemented Interfaces:

TypeDeclarationContainer, ModelElement, NonTerminalProgramElement, ProgramElement, ScopeDefiningElement, SourceElement, TypeScope, SVSubstitute

public class CompilationUnit
extends JavaNonTerminalProgramElement
implements TypeDeclarationContainer, TypeScope

A node representing a single source file containing TypeDeclarations and an optional PackageSpecification and an optional set of Imports. In Java, any source file may contain at most one public class type definition. This class is taken from COMPOST and changed so that it can be used as an immutable class

Nested Class Summary

Nested classes/interfaces inherited from class de.uka.ilkd.key.java.JavaProgramElement

JavaProgramElement.NameAbstractionTableDisabled

Field Summary

Fields

Modifier and Type	Field and Description
protected ImmutableArray<Import>	imports Imports.
protected PackageSpecification	packageSpec Package spec.
protected ImmutableArray<TypeDeclaration>	typeDeclarations Type declarations.

Constructor Summary

Constructors

Constructor and Description
CompilationUnit(ExtList children) creates a compilation unit
CompilationUnit(PackageSpecification packageSpec, Import[] imports, TypeDeclaration[] typeDeclarations) creates a compilation unit

Method Summary

Modifier and Type	Method and Description
ProgramElement	getChildAt(int index) Returns the child at the specified index in this node's "virtual" child array
int	getChildCount() Returns the number of children of this node.
ImmutableArray<TypeDeclaration>	getDeclarations() Get declarations.
SourceElement	getFirstElement() Finds the source element that occurs first in the source.
SourceElement	getFirstElementIncludingBlocks() Finds the source element that occurs first in the source.
ImmutableArray<Import>	getImports() Get imports.
SourceElement	getLastElement() Finds the source element that occurs last in the source.
java.lang.String	getName() Get name of the unit.
PackageSpecification	getPackageSpecification() Get package specification.
TypeDeclaration	getPrimaryTypeDeclaration() Gets the primary type declaration of the compilation unit.
TypeDeclaration	getTypeDeclarationAt(int index)
int	getTypeDeclarationCount() Get the number of type declarations in this container.
void	prettyPrint(PrettyPrinter p) Pretty printing the source element.
java.lang.String	toString() toString
void	visit(Visitor v) calls the corresponding method of a visitor in order to perform some action/transformation on this element

Methods inherited from class de.uka.ilkd.key.java.JavaNonTerminalProgramElement

compatibleBlockSize, computeHashCode, equals, equalsModRenaming, getArrayPos, match, matchChildren

Methods inherited from class de.uka.ilkd.key.java.JavaProgramElement

getComments, hashCode, prettyPrintMain, reuseSignature

Methods inherited from class de.uka.ilkd.key.java.JavaSourceElement

getEndPosition, getParentClass, getPositionInfo, getRelativePosition, getStartPosition, setParentClass, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.uka.ilkd.key.java.ProgramElement

getComments, match

Methods inherited from interface de.uka.ilkd.key.java.SourceElement

equalsModRenaming, getEndPosition, getPositionInfo, getRelativePosition, getStartPosition

Field Detail

packageSpec

protected final PackageSpecification packageSpec

Package spec.

imports

protected final ImmutableArray<Import> imports

Imports.

typeDeclarations

protected final ImmutableArray<TypeDeclaration> typeDeclarations

Type declarations.

Constructor Detail

CompilationUnit

public CompilationUnit(PackageSpecification packageSpec,
                       Import[] imports,
                       TypeDeclaration[] typeDeclarations)

creates a compilation unit

Parameters:

packageSpec - a PackageSpecification (pck of this CU)

imports - an array of Import (all it imports)

typeDeclarations - an array of TypeDeclaration (the type declared in it)

CompilationUnit

public CompilationUnit(ExtList children)

creates a compilation unit

Parameters:

children - list with the children of this unit

Method Detail

getFirstElement

public SourceElement getFirstElement()

Description copied from class: JavaSourceElement

Finds the source element that occurs first in the source. The default implementation returns this element, which is correct for all terminal program elements, and many non terminals such as statements and prefixed operators.

Specified by:

getFirstElement in interface SourceElement

Overrides:

getFirstElement in class JavaSourceElement

Returns:

the first source element in the syntactical representation of this element, may be equals to this element.

See Also:

JavaSourceElement.toSource(), JavaSourceElement.getStartPosition()

getFirstElementIncludingBlocks

public SourceElement getFirstElementIncludingBlocks()

Description copied from interface: SourceElement

Finds the source element that occurs first in the source.

Specified by:

getFirstElementIncludingBlocks in interface SourceElement

Overrides:

getFirstElementIncludingBlocks in class JavaSourceElement

Returns:

the first source element in the syntactical representation of this element, may be equals to this element.

See Also:

SourceElement.getStartPosition()

getLastElement

public SourceElement getLastElement()

Description copied from class: JavaSourceElement

Finds the source element that occurs last in the source. The default implementation returns this element, which is correct for all terminal program elements, and many non terminals such as statements and prefixed operators.

Specified by:

getLastElement in interface SourceElement

Overrides:

getLastElement in class JavaSourceElement

Returns:

the last source element in the syntactical representation of this element, may be equals to this element.

See Also:

JavaSourceElement.toSource(), JavaSourceElement.getEndPosition()

getName

public java.lang.String getName()

Get name of the unit. The name is empty if no data location is set; otherwise, the name of the current data location is returned.

Returns:

the name of this compilation unit.

getChildCount

public int getChildCount()

Returns the number of children of this node.

Specified by:

getChildCount in interface NonTerminalProgramElement

Returns:

an int giving the number of children of this node

getChildAt

public ProgramElement getChildAt(int index)

Returns the child at the specified index in this node's "virtual" child array

Specified by:

getChildAt in interface NonTerminalProgramElement

Parameters:

index - an index into this node's "virtual" child array

Returns:

the program element at the given position

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index is out of bounds

getImports

public ImmutableArray<Import> getImports()

Get imports.

Returns:

the wrapped import array.

getPackageSpecification

public PackageSpecification getPackageSpecification()

Get package specification.

Returns:

the package specification.

getTypeDeclarationCount

public int getTypeDeclarationCount()

Get the number of type declarations in this container.

Specified by:

getTypeDeclarationCount in interface TypeDeclarationContainer

Returns:

the number of type declarations.

getTypeDeclarationAt

public TypeDeclaration getTypeDeclarationAt(int index)

Specified by:

getTypeDeclarationAt in interface TypeDeclarationContainer

getDeclarations

public ImmutableArray<TypeDeclaration> getDeclarations()

Get declarations.

Returns:

the wrapped array of type declarations .

getPrimaryTypeDeclaration

public TypeDeclaration getPrimaryTypeDeclaration()

Gets the primary type declaration of the compilation unit. The primary declaration is the first declaration of the unit, or the single public declaration. If there is no unambiguous primary declaration, this method returns null.

prettyPrint

public void prettyPrint(PrettyPrinter p)
                 throws java.io.IOException

Description copied from class: JavaSourceElement

Pretty printing the source element.

Specified by:

prettyPrint in interface SourceElement

Overrides:

prettyPrint in class JavaProgramElement

Parameters:

p - a pretty printer.

Throws:

java.io.IOException - occasionally thrown.

visit

public void visit(Visitor v)

calls the corresponding method of a visitor in order to perform some action/transformation on this element

Specified by:

visit in interface SourceElement

Parameters:

v - the Visitor

toString

public java.lang.String toString()

toString

Overrides:

toString in class JavaSourceElement