Package spoon.support.reflect.declaration

Class CtCompilationUnitImpl

java.lang.Object

spoon.support.reflect.declaration.CtElementImpl

spoon.support.reflect.declaration.CtCompilationUnitImpl

All Implemented Interfaces:

Serializable, Cloneable, FactoryAccessor, SourcePositionHolder, CtCompilationUnit, CtElement, CtQueryable, CtVisitable

Direct Known Subclasses:

CompilationUnitImpl

public class CtCompilationUnitImpl
extends CtElementImpl
implements CtCompilationUnit

Implements a compilation unit. In Java, a compilation unit can contain only one public type declaration and other secondary types declarations (not public).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface spoon.reflect.declaration.CtCompilationUnit

CtCompilationUnit.UNIT_TYPE

Field Summary

Fields inherited from class spoon.support.reflect.declaration.CtElementImpl

ERROR_MESSAGE_TO_STRING, factory, LOGGER, parent

Constructor Summary

Constructors

Constructor	Description
CtCompilationUnitImpl()

Method Summary

Modifier and Type	Method	Description
void	accept(CtVisitor visitor)	Accepts a visitor
CtCompilationUnitImpl	addDeclaredType(CtType<?> type)	Add a type to the list of declared types.
CtCompilationUnitImpl	addDeclaredTypeReference(CtTypeReference<?> type)	Add a type reference to the list of declared types
CtCompilationUnitImpl	clone()	Clone the element which calls this method in a new object.
List<File>	getBinaryFiles()	Gets all binary (.class) files that corresponds to this compilation unit and have been created by calling SpoonModelBuilder.compile(spoon.SpoonModelBuilder.InputType...).
CtModule	getDeclaredModule()	Gets the declared module if the compilationUnit is "module-info.java"
CtModuleReference	getDeclaredModuleReference()	Gets the declared module reference if the compilationUnit is "module-info.java"
CtPackage	getDeclaredPackage()	Gets the declared package
List<CtTypeReference<?>>	getDeclaredTypeReferences()	Gets references to all the types declared in this compilation unit.
List<CtType<?>>	getDeclaredTypes()	Gets all the types declared in this compilation unit.
File	getFile()	Gets the file that corresponds to this compilation unit if any (contains the source code).
ModelList<CtImport>	getImports()	Get the imports computed for this CU.
int[]	getLineSeparatorPositions()
CtType<?>	getMainType()	Searches and returns the main type (the type which has the same name as the file).
SourcePosition	getOrCreatePartialSourcePosition()
String	getOriginalSourceCode()	Gets the original source code as a string.
ElementSourceFragment	getOriginalSourceFragment()	Returns the original source code (maybe different from toString() if a transformation has been applied).
CtPackageDeclaration	getPackageDeclaration()
CtElement	getParent()	Gets the parent of current reference.
SourcePosition	getPosition()	Gets the position of this element in input source files
CtCompilationUnit.UNIT_TYPE	getUnitType()	Returns the declaration type of the compilation unit.
CtCompilationUnitImpl	setDeclaredModule(CtModule module)	Sets the declared module if the compilationUnit is "module-info.java" It is here for backward compatibility.
CtCompilationUnitImpl	setDeclaredModuleReference(CtModuleReference module)	Sets the declared module reference if the compilationUnit is "module-info.java"
CtCompilationUnitImpl	setDeclaredPackage(CtPackage ctPackage)	Sets the package declaration using the instance of CtPackage.
CtCompilationUnitImpl	setDeclaredTypeReferences(List<CtTypeReference<?>> types)	Sets the references to types declared in this compilation unit.
CtCompilationUnit	setDeclaredTypes(List<CtType<?>> types)	Sets the types declared in this compilation unit.
CtCompilationUnitImpl	setFile(File file)	Sets the file that corresponds to this compilation unit.
CtCompilationUnitImpl	setImports(Collection<CtImport> imports)	Set the imports of this CU WARNING: This method is tagged as experimental, as its signature and/or usage might change in future release.
CtCompilationUnitImpl	setLineSeparatorPositions(int[] lineSeparatorPositions)
CtCompilationUnitImpl	setPackageDeclaration(CtPackageDeclaration packageDeclaration)	Sets the package declaration
<E extends CtElement> E	setParent(CtElement parent)	Manually sets the parent element of the current element.
<E extends CtElement> E	setPosition(SourcePosition position)	Sets the position in the Java source file.
String	toString()

Methods inherited from class spoon.support.reflect.declaration.CtElementImpl

addAnnotation, addComment, asIterable, comment, delete, descendantIterator, emptyList, emptySet, equals, filterChildren, getAllMetadata, getAnnotatedChildren, getAnnotation, getAnnotation, getAnnotations, getComments, getDirectChildren, getDocComment, getElements, getFactory, getMetadata, getMetadataKeys, getParent, getParent, getPath, getReferencedTypes, getRoleInParent, getShortRepresentation, getValueByRole, hasAnnotation, hashCode, hasParent, isImplicit, isParentInitialized, map, map, prettyprint, putMetadata, removeAnnotation, removeComment, replace, replace, setAllMetadata, setAnnotations, setComments, setDocComment, setFactory, setImplicit, setPositions, setValueByRole, toStringDebug, unmodifiableList, updateAllParentsBelow

Methods inherited from class java.lang.Object

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

Methods inherited from interface spoon.reflect.declaration.CtElement

addAnnotation, addComment, asIterable, delete, descendantIterator, getAllMetadata, getAnnotatedChildren, getAnnotation, getAnnotation, getAnnotations, getComments, getDirectChildren, getDocComment, getElements, getMetadata, getMetadataKeys, getParent, getParent, getPath, getReferencedTypes, getRoleInParent, getShortRepresentation, getValueByRole, hasAnnotation, hasParent, isImplicit, isParentInitialized, prettyprint, putMetadata, removeAnnotation, removeComment, replace, replace, setAllMetadata, setAnnotations, setComments, setDocComment, setImplicit, setPositions, setValueByRole, toStringDebug, updateAllParentsBelow

Methods inherited from interface spoon.reflect.visitor.chain.CtQueryable

filterChildren, map, map

Methods inherited from interface spoon.processing.FactoryAccessor

getFactory, setFactory

Constructor Details

CtCompilationUnitImpl

public CtCompilationUnitImpl()

Method Details

getUnitType

public CtCompilationUnit.UNIT_TYPE getUnitType()

Description copied from interface: CtCompilationUnit

Returns the declaration type of the compilation unit.

Specified by:

getUnitType in interface CtCompilationUnit

getFile

public File getFile()

Description copied from interface: CtCompilationUnit

Gets the file that corresponds to this compilation unit if any (contains the source code).

Specified by:

getFile in interface CtCompilationUnit

getMainType

public CtType<?> getMainType()

Description copied from interface: CtCompilationUnit

Searches and returns the main type (the type which has the same name as the file).

Specified by:

getMainType in interface CtCompilationUnit

getDeclaredTypes

public List<CtType<?>> getDeclaredTypes()

Description copied from interface: CtCompilationUnit

Gets all the types declared in this compilation unit.

Specified by:

getDeclaredTypes in interface CtCompilationUnit

getDeclaredTypeReferences

public List<CtTypeReference<?>> getDeclaredTypeReferences()

Description copied from interface: CtCompilationUnit

Gets references to all the types declared in this compilation unit.

Specified by:

getDeclaredTypeReferences in interface CtCompilationUnit

setDeclaredTypeReferences

public CtCompilationUnitImpl setDeclaredTypeReferences(List<CtTypeReference<?>> types)

Description copied from interface: CtCompilationUnit

Sets the references to types declared in this compilation unit.

Specified by:

setDeclaredTypeReferences in interface CtCompilationUnit

setDeclaredTypes

public CtCompilationUnit setDeclaredTypes(List<CtType<?>> types)

Description copied from interface: CtCompilationUnit

Sets the types declared in this compilation unit. It is here for backward compatibility. It calls internally CtCompilationUnit.setDeclaredTypeReferences(List) so the CtCompilationUnit contains type reference only. It doesn't contain whole type, which belongs to it's CtPackage in primary `java concept` model. Note that CtCompilationUnit represents a secondary model related to mapping of java modules, packages and types to file system.

Specified by:

setDeclaredTypes in interface CtCompilationUnit

addDeclaredType

public CtCompilationUnitImpl addDeclaredType(CtType<?> type)

Description copied from interface: CtCompilationUnit

Add a type to the list of declared types. It is here for backward compatibility. It calls internally CtCompilationUnit.addDeclaredTypeReference(CtTypeReference) so the CtCompilationUnit contains type reference only. It doesn't contain whole type, which belongs to it's CtPackage in primary `java concept` model. Note that CtCompilationUnit represents a secondary model related to mapping of java modules, packages and types to file system.

Specified by:

addDeclaredType in interface CtCompilationUnit

addDeclaredTypeReference

public CtCompilationUnitImpl addDeclaredTypeReference(CtTypeReference<?> type)

Description copied from interface: CtCompilationUnit

Add a type reference to the list of declared types

Specified by:

addDeclaredTypeReference in interface CtCompilationUnit

getDeclaredModule

public CtModule getDeclaredModule()

Description copied from interface: CtCompilationUnit

Gets the declared module if the compilationUnit is "module-info.java"

Specified by:

getDeclaredModule in interface CtCompilationUnit

getDeclaredModuleReference

public CtModuleReference getDeclaredModuleReference()

Description copied from interface: CtCompilationUnit

Gets the declared module reference if the compilationUnit is "module-info.java"

Specified by:

getDeclaredModuleReference in interface CtCompilationUnit

setDeclaredModule

public CtCompilationUnitImpl setDeclaredModule(CtModule module)

Description copied from interface: CtCompilationUnit

Sets the declared module if the compilationUnit is "module-info.java" It is here for backward compatibility. It internally calls CtCompilationUnit.setDeclaredModuleReference(CtModuleReference) It doesn't contain whole CtModule, which belongs to CtModel in primary `java concept` model. Note that CtCompilationUnit represents a secondary model related to mapping of java modules, packages and types to file system.

Specified by:

setDeclaredModule in interface CtCompilationUnit

setDeclaredModuleReference

public CtCompilationUnitImpl setDeclaredModuleReference(CtModuleReference module)

Description copied from interface: CtCompilationUnit

Sets the declared module reference if the compilationUnit is "module-info.java"

Specified by:

setDeclaredModuleReference in interface CtCompilationUnit

getDeclaredPackage

public CtPackage getDeclaredPackage()

Description copied from interface: CtCompilationUnit

Gets the declared package

Specified by:

getDeclaredPackage in interface CtCompilationUnit

getPackageDeclaration

public CtPackageDeclaration getPackageDeclaration()

Specified by:

getPackageDeclaration in interface CtCompilationUnit

Returns:

the package declaration

setDeclaredPackage

public CtCompilationUnitImpl setDeclaredPackage(CtPackage ctPackage)

Description copied from interface: CtCompilationUnit

Sets the package declaration using the instance of CtPackage. It is here for backward compatibility. It calls internally CtCompilationUnit.setPackageDeclaration(CtPackageDeclaration) It doesn't contain whole CtPackage, which belongs to it's parent package or to CtModule in primary `java concept` model. Note that CtCompilationUnit represents a secondary model related to mapping of java modules, packages and types to file system.

Specified by:

setDeclaredPackage in interface CtCompilationUnit

setPackageDeclaration

public CtCompilationUnitImpl setPackageDeclaration(CtPackageDeclaration packageDeclaration)

Description copied from interface: CtCompilationUnit

Sets the package declaration

Specified by:

setPackageDeclaration in interface CtCompilationUnit

setFile

public CtCompilationUnitImpl setFile(File file)

Description copied from interface: CtCompilationUnit

Sets the file that corresponds to this compilation unit.

Specified by:

setFile in interface CtCompilationUnit

getBinaryFiles

public List<File> getBinaryFiles()

Description copied from interface: CtCompilationUnit

Gets all binary (.class) files that corresponds to this compilation unit and have been created by calling SpoonModelBuilder.compile(spoon.SpoonModelBuilder.InputType...).

Specified by:

getBinaryFiles in interface CtCompilationUnit

getOriginalSourceCode

public String getOriginalSourceCode()

Description copied from interface: CtCompilationUnit

Gets the original source code as a string.

Specified by:

getOriginalSourceCode in interface CtCompilationUnit

getImports

public ModelList<CtImport> getImports()

Description copied from interface: CtCompilationUnit

Get the imports computed for this CU. WARNING: This method is tagged as experimental, as its signature and/or usage might change in future release.

Specified by:

getImports in interface CtCompilationUnit

Returns:

All the imports from the original source code

setImports

public CtCompilationUnitImpl setImports(Collection<CtImport> imports)

Description copied from interface: CtCompilationUnit

Set the imports of this CU WARNING: This method is tagged as experimental, as its signature and/or usage might change in future release.

Specified by:

setImports in interface CtCompilationUnit

Parameters:

imports - All the imports of the original source code

getOriginalSourceFragment

public ElementSourceFragment getOriginalSourceFragment()

Description copied from interface: SourcePositionHolder

Returns the original source code (maybe different from toString() if a transformation has been applied). Warning: this is a advanced method which cannot be considered as part of the stable API

Specified by:

getOriginalSourceFragment in interface CtElement

Specified by:

getOriginalSourceFragment in interface SourcePositionHolder

Overrides:

getOriginalSourceFragment in class CtElementImpl

getLineSeparatorPositions

public int[] getLineSeparatorPositions()

Specified by:

getLineSeparatorPositions in interface CtCompilationUnit

Returns:

array of offsets in the origin source file, where occurs line separator

setLineSeparatorPositions

public CtCompilationUnitImpl setLineSeparatorPositions(int[] lineSeparatorPositions)

Specified by:

setLineSeparatorPositions in interface CtCompilationUnit

Parameters:

lineSeparatorPositions - array of offsets in the origin source file, where occurs line separator

getPosition

public SourcePosition getPosition()

Description copied from interface: CtElement

Gets the position of this element in input source files

Specified by:

getPosition in interface CtElement

Specified by:

getPosition in interface SourcePositionHolder

Overrides:

getPosition in class CtElementImpl

Returns:

Source file and line number of this element. It never returns null. Use SourcePosition.isValidPosition() to detect whether return instance contains start/end indexes.

setPosition

public <E extends CtElement> E setPosition(SourcePosition position)

Description copied from interface: CtElement

Sets the position in the Java source file. Note that this information is used to feed the line numbers in the generated bytecode if any (which is useful for debugging).

Specified by:

setPosition in interface CtCompilationUnit

Specified by:

setPosition in interface CtElement

Overrides:

setPosition in class CtElementImpl

Parameters:

position - of this element in the input source files

getOrCreatePartialSourcePosition

public SourcePosition getOrCreatePartialSourcePosition()

Returns:

a SourcePosition which points to this CompilationUnit. It always returns same value to safe memory.

accept

public void accept(CtVisitor visitor)

Description copied from interface: CtVisitable

Accepts a visitor

Specified by:

accept in interface CtVisitable

clone

public CtCompilationUnitImpl clone()

Description copied from interface: CtElement

Clone the element which calls this method in a new object. Note that that references are kept as is, and thus, so if you clone whole classes or methods, some parts of the cloned element (eg executable references) may still point to the initial element. In this case, consider using methods Refactoring.copyType(CtType) and Refactoring.copyMethod(CtMethod) instead which does additional work beyond cloning.

Specified by:

clone in interface CtCompilationUnit

Specified by:

clone in interface CtElement

Overrides:

clone in class CtElementImpl

getParent

public CtElement getParent()
                    throws ParentNotInitializedException

Description copied from interface: CtElement

Gets the parent of current reference.

Specified by:

getParent in interface CtCompilationUnit

Specified by:

getParent in interface CtElement

Overrides:

getParent in class CtElementImpl

Throws:

ParentNotInitializedException - when the parent of this element is not initialized

setParent

public <E extends CtElement> E setParent(CtElement parent)

Description copied from interface: CtElement

Manually sets the parent element of the current element.

Specified by:

setParent in interface CtCompilationUnit

Specified by:

setParent in interface CtElement

Overrides:

setParent in class CtElementImpl

Type Parameters:

E - this element's type

Parameters:

parent - parent reference.

Returns:

this element

toString

public String toString()

Specified by:

toString in interface CtElement

Overrides:

toString in class CtElementImpl

Returns:

the source code of this element according to the setting of Environment.getPrettyPrintingMode().