Module io.github.ascopes.jct

Package io.github.ascopes.jct.containers

Interface ModuleContainerGroup

All Superinterfaces:

AutoCloseable, Closeable, ContainerGroup

All Known Subinterfaces:

OutputContainerGroup

@API(since="0.0.1",
     status=STABLE)
public interface ModuleContainerGroup
extends ContainerGroup

A container group implementation that holds zero or more modules.

These modules can be accessed by their module name. Each one holds a separate group of containers, and has the ability to produce a custom class loader.

Since:

0.0.1

Author:

Ashley Scopes

Method Summary

Modifier and Type	Method	Description
void	addModule(String module, Container container)	Add a container to this group.
void	addModule(String module, PathRoot path)	Add a path to this group for a module.
JavaFileManager.Location	getLocation()	Get the module-oriented location.
Set<JavaFileManager.Location>	getLocationsForModules()	Get all locations that are modules.
@Nullable PackageContainerGroup	getModule(String module)	Find the package container group for the given module.
Map<ModuleLocation,PackageContainerGroup>	getModules()	Get the module container impl in this group.
PackageContainerGroup	getOrCreateModule(String moduleName)	Get the PackageContainerGroup for a given module name, creating it if it does not yet exist.
boolean	hasLocation(ModuleLocation location)	Determine if this group contains a given module.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface io.github.ascopes.jct.containers.ContainerGroup

contains, getRelease, getServiceLoader

Method Details

addModule

void addModule(String module,
 Container container)

Add a container to this group.

The provided container will be closed when this container group is closed.

Parameters:

module - the module that the container is for.

container - the container to add.

addModule

void addModule(String module,
 PathRoot path)

Add a path to this group for a module.

Parameters:

module - the name of the module that this is for.

path - the path to add.

getModule

@Nullable PackageContainerGroup getModule(String module)

Find the package container group for the given module.

Parameters:

module - the module name.

Returns:

the container group, or null if no module was found by that name.

getOrCreateModule

PackageContainerGroup getOrCreateModule(String moduleName)

Get the PackageContainerGroup for a given module name, creating it if it does not yet exist.

Parameters:

moduleName - the module name to look up.

Returns:

the container group.

getLocation

JavaFileManager.Location getLocation()

Get the module-oriented location.

Specified by:

getLocation in interface ContainerGroup

Returns:

the module-oriented location.

getLocationsForModules

Set<JavaFileManager.Location> getLocationsForModules()

Get all locations that are modules.

Returns:

the locations that are modules.

getModules

Map<ModuleLocation,PackageContainerGroup> getModules()

Get the module container impl in this group.

Returns:

the container implementation.

hasLocation

boolean hasLocation(ModuleLocation location)

Determine if this group contains a given module.

Parameters:

location - the module location to look for.

Returns:

true if present, or false if not.