Module io.github.ascopes.jct

Package io.github.ascopes.jct.filemanagers

Interface JctFileManager

All Superinterfaces:

AutoCloseable, Closeable, Flushable, JavaFileManager, OptionChecker

@API(since="0.0.1",
     status=STABLE)
public interface JctFileManager
extends JavaFileManager

Extension around a JavaFileManager that allows adding of PathRoot objects to the manager.

This component is responsible for bridging the gap between a Workspace and a JavaCompiler when performing a compilation, and thus includes a number of required operations that the compiler will query the file system with. In addition, this interface also defines a number of additional functionalities that are useful for querying and verifying the outcome of compilations within tests.

Since:

0.0.1

Author:

Ashley Scopes

Nested Class Summary

Nested classes/interfaces inherited from interface javax.tools.JavaFileManager

JavaFileManager.Location

Method Summary

Modifier and Type	Method	Description
void	addPath(JavaFileManager.Location location, PathRoot path)	Add a package-oriented path to a given location.
void	addPaths(JavaFileManager.Location location, Collection<? extends PathRoot> paths)	Add a collection of package-oriented paths to a given location.
void	copyContainers(JavaFileManager.Location from, JavaFileManager.Location to)	Copy all containers from the first location to the second location.
void	createEmptyLocation(JavaFileManager.Location location)	Register an empty container for the given location to indicate to the compiler that the feature exists, but has no configured paths.
default @Nullable ModuleContainerGroup	getAnnotationProcessorModulePathGroup()	Get the location holding the annotation processor module path.
default @Nullable PackageContainerGroup	getAnnotationProcessorPathGroup()	Get the location holding the annotation processor path.
default @Nullable OutputContainerGroup	getClassOutputGroup()	Get the location holding the class outputs.
default @Nullable PackageContainerGroup	getClassPathGroup()	Get the location holding the class path.
String	getEffectiveRelease()	Get the associated effective release.
ModuleContainerGroup	getModuleContainerGroup(JavaFileManager.Location location)	Get the container group for the given module-oriented location.
Collection<ModuleContainerGroup>	getModuleContainerGroups()	Get a collection of all module container impl in this file manager.
default @Nullable ModuleContainerGroup	getModulePathGroup()	Get the location holding the module path.
default @Nullable ModuleContainerGroup	getModuleSourcePathGroup()	Get the location holding the module source path.
default @Nullable OutputContainerGroup	getNativeHeaderOutputGroup()	Deprecated, for removal: This API element is subject to removal in a future version. This is a specialist method that is usually not used.
OutputContainerGroup	getOutputContainerGroup(JavaFileManager.Location location)	Get the container group for the given output-oriented location.
Collection<OutputContainerGroup>	getOutputContainerGroups()	Get a collection of all output container impl in this file manager.
PackageContainerGroup	getPackageContainerGroup(JavaFileManager.Location location)	Get the container group for the given package-oriented location.
Collection<PackageContainerGroup>	getPackageContainerGroups()	Get a collection of all package container impl in this file manager.
default @Nullable ModuleContainerGroup	getPatchModulePathGroup()	Deprecated, for removal: This API element is subject to removal in a future version. This is a specialist method that is usually not used.
default @Nullable PackageContainerGroup	getPlatformClassPathGroup()	Deprecated, for removal: This API element is subject to removal in a future version. The platform class path has been mostly replaced by the use of system modules, so should not be used.
default @Nullable OutputContainerGroup	getSourceOutputGroup()	Get the location holding the source outputs.
default @Nullable PackageContainerGroup	getSourcePathGroup()	Get the location holding the source path.
default @Nullable ModuleContainerGroup	getSystemModulesGroup()	Deprecated, for removal: This API element is subject to removal in a future version. This is a specialist method that is usually not used.
default @Nullable ModuleContainerGroup	getUpgradeModulePathGroup()	Deprecated, for removal: This API element is subject to removal in a future version. This is a specialist method that is usually not used.
Set<JavaFileObject>	list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse)	List all file objects in the given location matching the given criteria.

Methods inherited from interface javax.tools.JavaFileManager

close, contains, flush, getClassLoader, getFileForInput, getFileForOutput, getJavaFileForInput, getJavaFileForOutput, getLocationForModule, getLocationForModule, getServiceLoader, handleOption, hasLocation, inferBinaryName, inferModuleName, isSameFile, listLocationsForModules

Methods inherited from interface javax.tools.OptionChecker

isSupportedOption

Method Details

addPath

void addPath(JavaFileManager.Location location,
 PathRoot path)

Add a package-oriented path to a given location.

To add a module, first obtain the module location using JavaFileManager.getLocationForModule(Location, String), and pass that result to this call.

Parameters:

location - the location to use.

path - the path to add.

See Also:

• JavaFileManager.getLocationForModule(Location, String)

addPaths

void addPaths(JavaFileManager.Location location,
 Collection<? extends PathRoot> paths)

Add a collection of package-oriented paths to a given location.

To add a module, first obtain the module location using JavaFileManager.getLocationForModule(Location, String), and pass that result to this call.

Parameters:

location - the location to use.

paths - the paths to add.

See Also:

• JavaFileManager.getLocationForModule(Location, String)

copyContainers

void copyContainers(JavaFileManager.Location from,
 JavaFileManager.Location to)

Copy all containers from the first location to the second location.

Parameters:

from - the first location.

to - the second location.

createEmptyLocation

void createEmptyLocation(JavaFileManager.Location location)

Register an empty container for the given location to indicate to the compiler that the feature exists, but has no configured paths.

This is needed to coerce the behaviour for annotation processing in some cases.

If the location already exists, then do not do anything.

If the location is an output location, then this operation does not make any sense, since an empty location cannot have files output to it. In this case, you will likely get an exception.

Likewise, this operation does not make sense for module locations within a module-oriented location group, so this operation will fail with an error for those inputs as well.

Parameters:

location - the location to apply an empty container for.

Throws:

IllegalArgumentException - if the location is an output location or a module location.

getEffectiveRelease

String getEffectiveRelease()

Get the associated effective release.

Returns:

the effective release.

Since:

0.0.1

getPackageContainerGroup

PackageContainerGroup getPackageContainerGroup(JavaFileManager.Location location)

Get the container group for the given package-oriented location.

Parameters:

location - the package oriented location.

Returns:

the container group, or null if one does not exist.

getPackageContainerGroups

Collection<PackageContainerGroup> getPackageContainerGroups()

Get a collection of all package container impl in this file manager.

Returns:

the package container impl.

getModuleContainerGroup

ModuleContainerGroup getModuleContainerGroup(JavaFileManager.Location location)

Get the container group for the given module-oriented location.

Parameters:

location - the module oriented location.

Returns:

the container group, or null if one does not exist.

getModuleContainerGroups

Collection<ModuleContainerGroup> getModuleContainerGroups()

Get a collection of all module container impl in this file manager.

Returns:

the module container impl.

getOutputContainerGroup

OutputContainerGroup getOutputContainerGroup(JavaFileManager.Location location)

Get the container group for the given output-oriented location.

Parameters:

location - the output oriented location.

Returns:

the container group, or null if one does not exist.

getOutputContainerGroups

Collection<OutputContainerGroup> getOutputContainerGroups()

Get a collection of all output container impl in this file manager.

Returns:

the output container impl.

list

Set<JavaFileObject> list(JavaFileManager.Location location,
 String packageName,
 Set<JavaFileObject.Kind> kinds,
 boolean recurse)
                  throws IOException

List all file objects in the given location matching the given criteria.

Specified by:

list in interface JavaFileManager

Parameters:

location - the location to search in.

packageName - the package name to search in, or "" to search in the root location.

kinds - the kinds of file to return, or Set.of() ( JavaFileObject.Kind.OTHER ) to find all files.

recurse - true to recurse into subpackages, false to only check the current package.

Returns:

a collection of unique file objects that were found.

Throws:

IOException - if an IO error occurs reading the file system.

getClassOutputGroup

default @Nullable OutputContainerGroup getClassOutputGroup()

Get the location holding the class outputs.

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0

getSourceOutputGroup

default @Nullable OutputContainerGroup getSourceOutputGroup()

Get the location holding the source outputs.

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0

getClassPathGroup

default @Nullable PackageContainerGroup getClassPathGroup()

Get the location holding the class path.

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0

getSourcePathGroup

default @Nullable PackageContainerGroup getSourcePathGroup()

Get the location holding the source path.

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0

getAnnotationProcessorPathGroup

default @Nullable PackageContainerGroup getAnnotationProcessorPathGroup()

Get the location holding the annotation processor path.

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0

getAnnotationProcessorModulePathGroup

default @Nullable ModuleContainerGroup getAnnotationProcessorModulePathGroup()

Get the location holding the annotation processor module path.

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0

getPlatformClassPathGroup

@Deprecated(forRemoval=true,
            since="0.6.0")
default @Nullable PackageContainerGroup getPlatformClassPathGroup()

Deprecated, for removal: This API element is subject to removal in a future version.

The platform class path has been mostly replaced by the use of system modules, so should not be used. This will be removed in v1.0.0.

Get the location holding the platform class path (also known as the boot class path).

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0

getNativeHeaderOutputGroup

@Deprecated(since="0.6.0",
            forRemoval=true)
default @Nullable OutputContainerGroup getNativeHeaderOutputGroup()

Deprecated, for removal: This API element is subject to removal in a future version.

This is a specialist method that is usually not used. To keep the API simple, this is being removed. You should instead call getOutputContainerGroup(Location), passing StandardLocation.NATIVE_HEADER_OUTPUT as the first parameter.

Get the location holding the native header outputs.

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0

getModuleSourcePathGroup

default @Nullable ModuleContainerGroup getModuleSourcePathGroup()

Get the location holding the module source path.

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0

getUpgradeModulePathGroup

@Deprecated(since="0.6.0",
            forRemoval=true)
default @Nullable ModuleContainerGroup getUpgradeModulePathGroup()

Deprecated, for removal: This API element is subject to removal in a future version.

This is a specialist method that is usually not used. To keep the API simple, this is being removed. You should instead call getModuleContainerGroup(Location), passing StandardLocation.SYSTEM_MODULES as the first parameter.

Get the location holding the upgrade module path.

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0

getSystemModulesGroup

@Deprecated(since="0.6.0",
            forRemoval=true)
default @Nullable ModuleContainerGroup getSystemModulesGroup()

Deprecated, for removal: This API element is subject to removal in a future version.

This is a specialist method that is usually not used. To keep the API simple, this is being removed. You should instead call getModuleContainerGroup(Location), passing StandardLocation.SYSTEM_MODULES as the first parameter.

Get the location holding the system modules.

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0

getModulePathGroup

default @Nullable ModuleContainerGroup getModulePathGroup()

Get the location holding the module path.

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0

getPatchModulePathGroup

@Deprecated(since="0.6.0",
            forRemoval=true)
default @Nullable ModuleContainerGroup getPatchModulePathGroup()

Deprecated, for removal: This API element is subject to removal in a future version.

This is a specialist method that is usually not used. To keep the API simple, this is being removed. You should instead call getModuleContainerGroup(Location), passing StandardLocation.PATCH_MODULE_PATH as the first parameter.

Get the location holding the patch module path.

Returns:

the location, or null if the location is not present in the file manager.

Since:

0.1.0