Package spoon.reflect.declaration

Interface CtModule

All Superinterfaces:

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

All Known Implementing Classes:

CtModuleImpl, ModuleFactory.CtUnnamedModule

public interface CtModule
extends CtNamedElement

Represents a Java module as defined in Java 9. Modules are defined in `module-info.java` as follows:

     module com.example.foo {

     }
 

Modules define required modules, and exported packages for client code. A module can export a service, defined as a type. Provided services are implementations of given service. Modules can require services ("uses" in Java 9) An open module, with the open modifier, grants access at compile time to types in only those packages which are explicitly exported, but grants access at run time to types in all its packages, as if all packages had been exported.

Field Summary

Fields

Modifier and Type	Field	Description
static String	TOP_LEVEL_MODULE_NAME	The name for the top level module.

Method Summary

Modifier and Type	Method	Description
<T extends CtModule> T	addExportedPackage(CtPackageExport exportedPackage)
<T extends CtModule> T	addModuleDirective(CtModuleDirective moduleDirective)
<T extends CtModule> T	addModuleDirectiveAt(int position, CtModuleDirective moduleDirective)
<T extends CtModule> T	addOpenedPackage(CtPackageExport openedPackage)
<T extends CtModule> T	addProvidedService(CtProvidedService providedService)
<T extends CtModule> T	addRequiredModule(CtModuleRequirement requiredModule)
<T extends CtModule> T	addUsedService(CtUsedService usedService)
CtModule	clone()	Clone the element which calls this method in a new object.
List<CtPackageExport>	getExportedPackages()
List<CtModuleDirective>	getModuleDirectives()
List<CtPackageExport>	getOpenedPackages()
List<CtProvidedService>	getProvidedServices()
CtModuleReference	getReference()	Returns the corresponding reference.
List<CtModuleRequirement>	getRequiredModules()
CtPackage	getRootPackage()	returns the root package of the unnamed module If there are several modules, it throws an exception
List<CtUsedService>	getUsedServices()
boolean	isOpenModule()
boolean	isUnnamedModule()	Returns true if the module is the unnamed module
<T extends CtModule> T	removeExportedPackage(CtPackageExport exportedPackage)
<T extends CtModule> T	removeModuleDirective(CtModuleDirective moduleDirective)
<T extends CtModule> T	removeOpenedPackage(CtPackageExport openedPackage)
<T extends CtModule> T	removeProvidedService(CtProvidedService providedService)
<T extends CtModule> T	removeRequiredModule(CtModuleRequirement requiredModule)
<T extends CtModule> T	removeUsedService(CtUsedService usedService)
<T extends CtModule> T	setExportedPackages(List<CtPackageExport> exportedPackages)
<T extends CtModule> T	setIsOpenModule(boolean openModule)
<T extends CtModule> T	setModuleDirectives(List<CtModuleDirective> moduleDirectives)
<T extends CtModule> T	setOpenedPackages(List<CtPackageExport> openedPackages)
<T extends CtModule> T	setProvidedServices(List<CtProvidedService> providedServices)
<T extends CtModule> T	setRequiredModules(List<CtModuleRequirement> requiredModules)
<T extends CtModule> T	setRootPackage(CtPackage rootPackage)
<T extends CtModule> T	setUsedServices(List<CtUsedService> usedServices)

Methods inherited from interface spoon.reflect.declaration.CtElement

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

Methods inherited from interface spoon.reflect.declaration.CtNamedElement

getSimpleName, setSimpleName

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

filterChildren, map, map

Methods inherited from interface spoon.reflect.visitor.CtVisitable

accept

Methods inherited from interface spoon.processing.FactoryAccessor

getFactory, setFactory

Field Details

TOP_LEVEL_MODULE_NAME

static final String TOP_LEVEL_MODULE_NAME

The name for the top level module.

See Also:

Constant Field Values

Method Details

isUnnamedModule

boolean isUnnamedModule()

Returns true if the module is the unnamed module

isOpenModule

boolean isOpenModule()

setIsOpenModule

<T extends CtModule> T setIsOpenModule(boolean openModule)

setModuleDirectives

<T extends CtModule> T setModuleDirectives(List<CtModuleDirective> moduleDirectives)

addModuleDirective

<T extends CtModule> T addModuleDirective(CtModuleDirective moduleDirective)

addModuleDirectiveAt

<T extends CtModule> T addModuleDirectiveAt(int position,
 CtModuleDirective moduleDirective)

getModuleDirectives

List<CtModuleDirective> getModuleDirectives()

removeModuleDirective

<T extends CtModule> T removeModuleDirective(CtModuleDirective moduleDirective)

getUsedServices

List<CtUsedService> getUsedServices()

setUsedServices

<T extends CtModule> T setUsedServices(List<CtUsedService> usedServices)

addUsedService

<T extends CtModule> T addUsedService(CtUsedService usedService)

removeUsedService

<T extends CtModule> T removeUsedService(CtUsedService usedService)

getExportedPackages

List<CtPackageExport> getExportedPackages()

setExportedPackages

<T extends CtModule> T setExportedPackages(List<CtPackageExport> exportedPackages)

addExportedPackage

<T extends CtModule> T addExportedPackage(CtPackageExport exportedPackage)

removeExportedPackage

<T extends CtModule> T removeExportedPackage(CtPackageExport exportedPackage)

getOpenedPackages

List<CtPackageExport> getOpenedPackages()

setOpenedPackages

<T extends CtModule> T setOpenedPackages(List<CtPackageExport> openedPackages)

addOpenedPackage

<T extends CtModule> T addOpenedPackage(CtPackageExport openedPackage)

removeOpenedPackage

<T extends CtModule> T removeOpenedPackage(CtPackageExport openedPackage)

getRequiredModules

List<CtModuleRequirement> getRequiredModules()

setRequiredModules

<T extends CtModule> T setRequiredModules(List<CtModuleRequirement> requiredModules)

addRequiredModule

<T extends CtModule> T addRequiredModule(CtModuleRequirement requiredModule)

removeRequiredModule

<T extends CtModule> T removeRequiredModule(CtModuleRequirement requiredModule)

getProvidedServices

List<CtProvidedService> getProvidedServices()

setProvidedServices

<T extends CtModule> T setProvidedServices(List<CtProvidedService> providedServices)

addProvidedService

<T extends CtModule> T addProvidedService(CtProvidedService providedService)

removeProvidedService

<T extends CtModule> T removeProvidedService(CtProvidedService providedService)

getRootPackage

CtPackage getRootPackage()

returns the root package of the unnamed module If there are several modules, it throws an exception

setRootPackage

<T extends CtModule> T setRootPackage(CtPackage rootPackage)

getReference

CtModuleReference getReference()

Description copied from interface: CtNamedElement

Returns the corresponding reference.

Specified by:

getReference in interface CtNamedElement

clone

CtModule 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 CtElement

Specified by:

clone in interface CtNamedElement