Module io.github.ascopes.jct

Package io.github.ascopes.jct.workspaces

Interface Workspace

All Superinterfaces:

AutoCloseable

@API(since="0.0.1",
     status=STABLE)
public interface Workspace
extends AutoCloseable

Interface for a Workspace to hold files and directories within.

This acts as a nexus for managing the lifetime of test sources and directories, and should be used within a try-with-resources block to ensure temporary files get released after the test completes.

Since:

0.0.1

Author:

Ashley Scopes

Method Summary

Modifier and Type	Method	Description
default void	addAnnotationProcessorPathModule(String moduleName, Path path)	Add a module to the annotation processor path.
default void	addAnnotationProcessorPathPackage(Path path)	Add a package to the annotation processor path.
default void	addClassOutputModule(String moduleName, Path path)	Add a module to the class outputs.
default void	addClassOutputPackage(Path path)	Add a package to the class outputs.
default void	addClassPathPackage(Path path)	Add a package to the class path.
void	addModule(JavaFileManager.Location location, String moduleName, Path path)	Add an existing package root to this workspace and associate it with the given module name in the given location.
default void	addModulePathModule(String moduleName, Path path)	Add a module to the module path.
default void	addNativeHeaderOutputModule(String moduleName, Path path)	Add a module to the native header outputs.
default void	addNativeHeaderOutputPackage(Path path)	Add a package to the native header outputs.
void	addPackage(JavaFileManager.Location location, Path path)	Add an existing package root to this workspace and associate it with the given location.
default void	addPatchModulePathModule(String moduleName, Path path)	Add a module to the patch module path.
default void	addPlatformClassPathPackage(Path path)	Add a package to the platform class path (also known as the boot class path).
default void	addSourceOutputModule(String moduleName, Path path)	Add a module to the source outputs.
default void	addSourceOutputPackage(Path path)	Add a package to the source outputs.
default void	addSourcePathModule(String moduleName, Path path)	Add a module to the source path.
default void	addSourcePathPackage(Path path)	Add a package to the source path.
default void	addSystemModulePathModule(String moduleName, Path path)	Add a module to the system module path.
default void	addUpgradeModulePathModule(String moduleName, Path path)	Add a module to the upgrade module path.
void	close()	Attempt to close all resources in this workspace.
default ManagedDirectory	createAnnotationProcessorPathModule(String moduleName)	Create a module in the annotation processor path.
default ManagedDirectory	createAnnotationProcessorPathPackage()	Create a package in the annotation processor path.
default ManagedDirectory	createClassOutputModule(String moduleName)	Create a module in the class outputs.
default ManagedDirectory	createClassOutputPackage()	Create a package in the class outputs.
default ManagedDirectory	createClassPathPackage()	Create a package in the class path.
ManagedDirectory	createModule(JavaFileManager.Location location, String moduleName)	Create a new test directory for a package root and associate it with the given module name in the given location.
default ManagedDirectory	createModulePathModule(String moduleName)	Create a module in the module path.
default ManagedDirectory	createNativeHeaderOutputModule(String moduleName)	Create a module in the native header outputs.
default ManagedDirectory	createNativeHeaderOutputPackage()	Create a package in the native header outputs.
ManagedDirectory	createPackage(JavaFileManager.Location location)	Create a new test directory for a package root and associate it with the given location.
default ManagedDirectory	createPatchModulePathModule(String moduleName)	Create a module in the patch module path.
default ManagedDirectory	createPlatformClassPathPackage()	Create a package in the platform class path (also known as the boot class path).
default ManagedDirectory	createSourceOutputModule(String moduleName)	Create a module in the source outputs.
default ManagedDirectory	createSourceOutputPackage()	Create a package in the source outputs.
default ManagedDirectory	createSourcePathModule(String moduleName)	Create a module in the source path.
default ManagedDirectory	createSourcePathPackage()	Create a package in the source path.
default ManagedDirectory	createSystemModulePathModule(String moduleName)	Create a module in the system module path.
default ManagedDirectory	createUpgradeModulePathModule(String moduleName)	Create a module in the upgrade module path.
Map<JavaFileManager.Location,List<? extends PathRoot>>	getAllPaths()	Get an immutable copy of the current paths to operate on.
PathStrategy	getPathStrategy()	Get the path strategy in use.

Method Details

addPackage

void addPackage(JavaFileManager.Location location,
 Path path)

Add an existing package root to this workspace and associate it with the given location.

The following constraints must be met, otherwise an IllegalArgumentException will be thrown:

• The location must not be module-oriented.
• The path must exist.

Parameters:

location - the location to associate with.

path - the path to add.

Throws:

IllegalArgumentException - if the inputs are invalid.

addModule

void addModule(JavaFileManager.Location location,
 String moduleName,
 Path path)

Add an existing package root to this workspace and associate it with the given module name in the given location.

The following constraints must be met, otherwise an IllegalArgumentException will be thrown:

• The location must be module-oriented or an output location.
• The location must not be a module-location handle already.
• The path must exist.

Parameters:

location - the location to associate with.

moduleName - the name of the module.

path - the path to add.

Throws:

IllegalArgumentException - if the inputs are invalid.

addClassOutputPackage

default void addClassOutputPackage(Path path)

Add a package to the class outputs.

Parameters:

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addClassOutputModule

default void addClassOutputModule(String moduleName,
 Path path)

Add a module to the class outputs.

Parameters:

moduleName - the module name.

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addSourceOutputPackage

default void addSourceOutputPackage(Path path)

Add a package to the source outputs.

Parameters:

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addSourceOutputModule

default void addSourceOutputModule(String moduleName,
 Path path)

Add a module to the source outputs.

Parameters:

moduleName - the module name.

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addClassPathPackage

default void addClassPathPackage(Path path)

Add a package to the class path.

Parameters:

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addModulePathModule

default void addModulePathModule(String moduleName,
 Path path)

Add a module to the module path.

Parameters:

moduleName - the module name.

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addSourcePathPackage

default void addSourcePathPackage(Path path)

Add a package to the source path.

Parameters:

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addSourcePathModule

default void addSourcePathModule(String moduleName,
 Path path)

Add a module to the source path.

Note that this will signal to the compiler to run in multi-module compilation mode. Any source packages that were added or createSourcePathPackage() created} will be ignored.

If you are using a single-module, you can add a source package and include a module-info.java in the base directory instead.

Parameters:

moduleName - the module name.

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addAnnotationProcessorPathPackage

default void addAnnotationProcessorPathPackage(Path path)

Add a package to the annotation processor path.

Note that this will be ignored if the compiler is provided with explicit annotation processor instances to run.

Parameters:

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addAnnotationProcessorPathModule

default void addAnnotationProcessorPathModule(String moduleName,
 Path path)

Add a module to the annotation processor path.

Note that this will be ignored if the compiler is provided with explicit annotation processor instances to run.

Parameters:

moduleName - the module name.

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addPlatformClassPathPackage

default void addPlatformClassPathPackage(Path path)

Add a package to the platform class path (also known as the boot class path).

Parameters:

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addNativeHeaderOutputPackage

default void addNativeHeaderOutputPackage(Path path)

Add a package to the native header outputs.

Parameters:

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addNativeHeaderOutputModule

default void addNativeHeaderOutputModule(String moduleName,
 Path path)

Add a module to the native header outputs.

Parameters:

moduleName - the name of the module.

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addUpgradeModulePathModule

default void addUpgradeModulePathModule(String moduleName,
 Path path)

Add a module to the upgrade module path.

Parameters:

moduleName - the module name.

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addSystemModulePathModule

default void addSystemModulePathModule(String moduleName,
 Path path)

Add a module to the system module path.

Parameters:

moduleName - the module name.

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

addPatchModulePathModule

default void addPatchModulePathModule(String moduleName,
 Path path)

Add a module to the patch module path.

Parameters:

moduleName - the module name.

path - the path to add.

Throws:

IllegalArgumentException - if the path does not exist.

close

void close()

Attempt to close all resources in this workspace.

Specified by:

close in interface AutoCloseable

Throws:

UncheckedIOException - if an error occurs.

createPackage

ManagedDirectory createPackage(JavaFileManager.Location location)

Create a new test directory for a package root and associate it with the given location.

This path will be destroyed when the workspace is closed.

The following constraints must be met, otherwise an IllegalArgumentException will be thrown:

• The location must not be module-oriented.

Parameters:

location - the location to associate with.

Returns:

the test directory that was created.

Throws:

IllegalArgumentException - if the inputs are invalid.

createModule

ManagedDirectory createModule(JavaFileManager.Location location,
 String moduleName)

Create a new test directory for a package root and associate it with the given module name in the given location.

This path will be destroyed when the workspace is closed.

The following constraints must be met, otherwise an IllegalArgumentException will be thrown:

• The location must be module-oriented or an output location.
• The location must not be a module-location handle already.

Parameters:

location - the location to associate with.

moduleName - the module name to use.

Returns:

the test directory that was created.

Throws:

IllegalArgumentException - if the inputs are invalid.

createClassOutputPackage

default ManagedDirectory createClassOutputPackage()

Create a package in the class outputs.

Returns:

the created test directory.

createClassOutputModule

default ManagedDirectory createClassOutputModule(String moduleName)

Create a module in the class outputs.

Parameters:

moduleName - the module name.

Returns:

the created test directory.

createSourceOutputPackage

default ManagedDirectory createSourceOutputPackage()

Create a package in the source outputs.

Returns:

the created test directory.

createSourceOutputModule

default ManagedDirectory createSourceOutputModule(String moduleName)

Create a module in the source outputs.

Parameters:

moduleName - the module name.

Returns:

the created test directory.

createClassPathPackage

default ManagedDirectory createClassPathPackage()

Create a package in the class path.

Returns:

the created test directory.

createModulePathModule

default ManagedDirectory createModulePathModule(String moduleName)

Create a module in the module path.

Parameters:

moduleName - the module name.

Returns:

the created test directory.

createSourcePathPackage

default ManagedDirectory createSourcePathPackage()

Create a package in the source path.

Returns:

the created test directory.

createSourcePathModule

default ManagedDirectory createSourcePathModule(String moduleName)

Create a module in the source path.

Note that this will signal to the compiler to run in multi-module compilation mode. Any source packages that were created or added will be ignored.

If you are using a single-module, you can create a source package and include a module-info.java in the base directory instead.

Parameters:

moduleName - the module name.

Returns:

the created test directory.

createAnnotationProcessorPathPackage

default ManagedDirectory createAnnotationProcessorPathPackage()

Create a package in the annotation processor path.

Note that this will be ignored if the compiler is provided with explicit annotation processor instances to run.

Returns:

the created test directory.

createAnnotationProcessorPathModule

default ManagedDirectory createAnnotationProcessorPathModule(String moduleName)

Create a module in the annotation processor path.

Note that this will be ignored if the compiler is provided with explicit annotation processor instances to run.

Parameters:

moduleName - the module name.

Returns:

the created test directory.

createPlatformClassPathPackage

default ManagedDirectory createPlatformClassPathPackage()

Create a package in the platform class path (also known as the boot class path).

Returns:

the created test directory.

createNativeHeaderOutputPackage

default ManagedDirectory createNativeHeaderOutputPackage()

Create a package in the native header outputs.

Returns:

the created test directory.

createNativeHeaderOutputModule

default ManagedDirectory createNativeHeaderOutputModule(String moduleName)

Create a module in the native header outputs.

Parameters:

moduleName - the module name.

Returns:

the created test directory.

createUpgradeModulePathModule

default ManagedDirectory createUpgradeModulePathModule(String moduleName)

Create a module in the upgrade module path.

Parameters:

moduleName - the module name.

Returns:

the created test directory.

createSystemModulePathModule

default ManagedDirectory createSystemModulePathModule(String moduleName)

Create a module in the system module path.

Parameters:

moduleName - the module name.

Returns:

the created test directory.

createPatchModulePathModule

default ManagedDirectory createPatchModulePathModule(String moduleName)

Create a module in the patch module path.

Parameters:

moduleName - the module name.

Returns:

the created test directory.

getAllPaths

Map<JavaFileManager.Location,List<? extends PathRoot>> getAllPaths()

Get an immutable copy of the current paths to operate on.

Returns:

the paths.

getPathStrategy

PathStrategy getPathStrategy()

Get the path strategy in use.

Returns:

the path strategy.