Module io.github.ascopes.jct

Package io.github.ascopes.jct.compilers

Interface JctCompiler

All Known Implementing Classes:

AbstractJctCompiler

@API(since="0.0.1",
     status=STABLE)
public interface JctCompiler

Base definition of a compiler that can be configured to perform a compilation run against sources.

JctCompiler objects are often a nexus that will manage configuring an underlying JSR-199 compiler internally in a platform-agnostic way.

Since:

0.0.1

Author:

Ashley Scopes

Field Summary

Fields

Modifier and Type	Field	Description
static final AnnotationProcessorDiscovery	DEFAULT_ANNOTATION_PROCESSOR_DISCOVERY	Default setting for how to apply annotation processor discovery when no processors are explicitly defined (AnnotationProcessorDiscovery.INCLUDE_DEPENDENCIES).
static final CompilationMode	DEFAULT_COMPILATION_MODE	Default setting for the compilation mode to use (CompilationMode.COMPILATION_AND_ANNOTATION_PROCESSING).
static final Set<DebuggingInfo>	DEFAULT_DEBUGGING_INFO	Default debugging info to include in the compilation (all possible info).
static final LoggingMode	DEFAULT_DIAGNOSTIC_LOGGING_MODE	Default setting for logging diagnostics (LoggingMode.ENABLED).
static final boolean	DEFAULT_FAIL_ON_WARNINGS	Default setting for displaying warnings as errors (false).
static final LoggingMode	DEFAULT_FILE_MANAGER_LOGGING_MODE	Default setting for logging file manager operations (LoggingMode.DISABLED).
static final boolean	DEFAULT_FIX_JVM_MODULE_PATH_MISMATCH	Default setting for fixing modules being placed on the classpath by mistake (true).
static final boolean	DEFAULT_INHERIT_CLASS_PATH	Default setting for inclusion of the current class path (true).
static final boolean	DEFAULT_INHERIT_MODULE_PATH	Default setting for inclusion of the current module path (true).
static final boolean	DEFAULT_INHERIT_SYSTEM_MODULE_PATH	Default setting for inclusion of the system module path (true).
static final Locale	DEFAULT_LOCALE	Default setting for locale (Locale.ROOT).
static final Charset	DEFAULT_LOG_CHARSET	Default charset to use for compiler logs (StandardCharsets.UTF_8).
static final boolean	DEFAULT_PARAMETER_INFO_ENABLED	Default preference for including reflective parameter information in compiled classes (true).
static final boolean	DEFAULT_PREVIEW_FEATURES	Default setting for preview features (false).
static final boolean	DEFAULT_SHOW_DEPRECATION_WARNINGS	Default setting for deprecation warnings (true).
static final boolean	DEFAULT_SHOW_WARNINGS	Default setting for displaying warnings (true).
static final boolean	DEFAULT_VERBOSE	Default setting for verbose logging (false).

Method Summary

Modifier and Type	Method	Description
JctCompiler	addAnnotationProcessorOptions(Iterable<String> annotationProcessorOptions)	Add options to pass to any annotation processors.
default JctCompiler	addAnnotationProcessorOptions(String... annotationProcessorOptions)	Add options to pass to any annotation processors.
JctCompiler	addAnnotationProcessors(Iterable<? extends Processor> annotationProcessors)	Add annotation processors to invoke.
default JctCompiler	addAnnotationProcessors(Processor... annotationProcessors)	Add annotation processors to invoke.
JctCompiler	addCompilerOptions(Iterable<String> compilerOptions)	Add command line options to pass to javac.
default JctCompiler	addCompilerOptions(String... compilerOptions)	Add command line options to pass to javac.
JctCompiler	annotationProcessorDiscovery(AnnotationProcessorDiscovery annotationProcessorDiscovery)	Set how to perform annotation processor discovery.
JctCompiler	compilationMode(CompilationMode compilationMode)	Set the compilation mode to use for this compiler.
JctCompilation	compile(Workspace workspace)	Invoke the compilation and return the compilation result.
default JctCompilation	compile(Workspace workspace, String... classNames)	Invoke the compilation and return the compilation result.
JctCompilation	compile(Workspace workspace, Collection<String> classNames)	Invoke the compilation and return the compilation result.
<E extends Exception> JctCompiler	configure(JctCompilerConfigurer<E> configurer)	Apply a given configurer to this compiler.
JctCompiler	debuggingInfo(Set<DebuggingInfo> debuggingInfoFlags)	Set the debugging info level to use.
JctCompiler	diagnosticLoggingMode(LoggingMode diagnosticLoggingMode)	Set how to handle diagnostic capture.
JctCompiler	failOnWarnings(boolean enabled)	Set whether to enable treating warnings as errors or not.
JctCompiler	fileManagerLoggingMode(LoggingMode fileManagerLoggingMode)	Set how to handle logging calls to underlying file managers.
JctCompiler	fixJvmModulePathMismatch(boolean fixJvmModulePathMismatch)	Get whether we will attempt to fix modules appearing on the classpath, or non-modules appearing on the module path.
AnnotationProcessorDiscovery	getAnnotationProcessorDiscovery()	Get how to perform annotation processor discovery.
List<String>	getAnnotationProcessorOptions()	Get an immutable snapshot view of the current annotation processor options that are set.
List<Processor>	getAnnotationProcessors()	Get an immutable snapshot view of the current annotation processors that are explicitly set to be run, in the order that they were provided to the compiler.
CompilationMode	getCompilationMode()	Get the compilation mode that is in use.
List<String>	getCompilerOptions()	Get an immutable snapshot view of the current compiler options that are set.
Set<DebuggingInfo>	getDebuggingInfo()	Get the debugging info that is enabled.
String	getDefaultRelease()	Get the default release to use if no release or target version is specified.
LoggingMode	getDiagnosticLoggingMode()	Get the current diagnostic logging mode.
String	getEffectiveRelease()	Get the effective release to use for the actual compilation.
LoggingMode	getFileManagerLoggingMode()	Get the current file manager logging mode.
Locale	getLocale()	Get the output locale.
Charset	getLogCharset()	Get the charset being used to write compiler logs with.
String	getName()	Get the friendly printable name of this compiler object.
@Nullable String	getRelease()	Get the current release version that is set, or null if left to the compiler to decide.
@Nullable String	getSource()	Get the current source version that is set, or null if left to the compiler to decide.
@Nullable String	getTarget()	Get the current target version that is set, or null if left to the compiler default.
JctCompiler	inheritClassPath(boolean inheritClassPath)	Set whether the class path is inherited from the active JVM or not.
JctCompiler	inheritModulePath(boolean inheritModulePath)	Set whether the module path is inherited from the active JVM or not.
JctCompiler	inheritSystemModulePath(boolean inheritSystemModulePath)	Set whether the system module path is inherited from the active JVM or not.
boolean	isFailOnWarnings()	Determine whether warnings are being treated as errors or not.
boolean	isFixJvmModulePathMismatch()	Get whether we will attempt to fix modules appearing on the classpath, or non-modules appearing on the module path.
boolean	isInheritClassPath()	Get whether the class path is inherited from the active JVM or not.
boolean	isInheritModulePath()	Get whether the module path is inherited from the active JVM or not.
boolean	isInheritSystemModulePath()	Get whether the system module path is inherited from the active JVM or not.
boolean	isParameterInfoEnabled()	Determine if including reflective parameter info is enabled or not.
boolean	isPreviewFeatures()	Determine whether preview features are enabled or not.
boolean	isShowDeprecationWarnings()	Determine whether deprecation warnings are enabled or not.
boolean	isShowWarnings()	Determine whether warnings are enabled or not.
boolean	isVerbose()	Determine whether verbose logging is enabled or not.
JctCompiler	locale(Locale locale)	Set the output locale.
JctCompiler	logCharset(Charset logCharset)	Set the charset being used to write compiler logs with.
JctCompiler	name(String name)	Set the friendly name of this compiler.
JctCompiler	parameterInfoEnabled(boolean parameterInfoEnabled)	Set whether to include parameter reflective info by default in compiled classes or not.
JctCompiler	previewFeatures(boolean enabled)	Set whether to enable compiler preview features or not.
default JctCompiler	release(int release)	Set the release version.
JctCompiler	release(@Nullable String release)	Set the release version.
default JctCompiler	release(SourceVersion release)	Set the release version.
JctCompiler	showDeprecationWarnings(boolean enabled)	Set whether to enable deprecation warnings or not.
JctCompiler	showWarnings(boolean enabled)	Set whether to enable displaying warnings or not.
default JctCompiler	source(int source)	Set the source version.
JctCompiler	source(@Nullable String source)	Set the source version.
default JctCompiler	source(SourceVersion source)	Set the source version.
default JctCompiler	target(int target)	Set the target version.
JctCompiler	target(@Nullable String target)	Set the target version.
default JctCompiler	target(SourceVersion target)	Set the target version.
default JctCompiler	useRuntimeRelease()	Request that the compiler uses a language version that corresponds to the runtime language version in use on the current JVM.
JctCompiler	verbose(boolean enabled)	Set whether to use verbose output or not.

Field Details

DEFAULT_SHOW_DEPRECATION_WARNINGS

static final boolean DEFAULT_SHOW_DEPRECATION_WARNINGS

Default setting for deprecation warnings (true).

See Also:

• Constant Field Values

DEFAULT_LOCALE

static final Locale DEFAULT_LOCALE

Default setting for locale (Locale.ROOT).

DEFAULT_PREVIEW_FEATURES

static final boolean DEFAULT_PREVIEW_FEATURES

Default setting for preview features (false).

See Also:

• Constant Field Values

DEFAULT_VERBOSE

static final boolean DEFAULT_VERBOSE

Default setting for verbose logging (false).

See Also:

• Constant Field Values

DEFAULT_SHOW_WARNINGS

static final boolean DEFAULT_SHOW_WARNINGS

Default setting for displaying warnings (true).

See Also:

• Constant Field Values

DEFAULT_FAIL_ON_WARNINGS

static final boolean DEFAULT_FAIL_ON_WARNINGS

Default setting for displaying warnings as errors (false).

See Also:

• Constant Field Values

DEFAULT_FIX_JVM_MODULE_PATH_MISMATCH

static final boolean DEFAULT_FIX_JVM_MODULE_PATH_MISMATCH

Default setting for fixing modules being placed on the classpath by mistake (true).

See Also:

• Constant Field Values

DEFAULT_INHERIT_CLASS_PATH

static final boolean DEFAULT_INHERIT_CLASS_PATH

Default setting for inclusion of the current class path (true).

See Also:

• Constant Field Values

DEFAULT_INHERIT_MODULE_PATH

static final boolean DEFAULT_INHERIT_MODULE_PATH

Default setting for inclusion of the current module path (true).

See Also:

• Constant Field Values

DEFAULT_INHERIT_SYSTEM_MODULE_PATH

static final boolean DEFAULT_INHERIT_SYSTEM_MODULE_PATH

Default setting for inclusion of the system module path (true).

See Also:

• Constant Field Values

DEFAULT_FILE_MANAGER_LOGGING_MODE

static final LoggingMode DEFAULT_FILE_MANAGER_LOGGING_MODE

Default setting for logging file manager operations (LoggingMode.DISABLED).

DEFAULT_DIAGNOSTIC_LOGGING_MODE

static final LoggingMode DEFAULT_DIAGNOSTIC_LOGGING_MODE

Default setting for logging diagnostics (LoggingMode.ENABLED).

DEFAULT_COMPILATION_MODE

static final CompilationMode DEFAULT_COMPILATION_MODE

Default setting for the compilation mode to use (CompilationMode.COMPILATION_AND_ANNOTATION_PROCESSING).

DEFAULT_ANNOTATION_PROCESSOR_DISCOVERY

static final AnnotationProcessorDiscovery DEFAULT_ANNOTATION_PROCESSOR_DISCOVERY

Default setting for how to apply annotation processor discovery when no processors are explicitly defined (AnnotationProcessorDiscovery.INCLUDE_DEPENDENCIES).

DEFAULT_LOG_CHARSET

static final Charset DEFAULT_LOG_CHARSET

Default charset to use for compiler logs (StandardCharsets.UTF_8).

DEFAULT_DEBUGGING_INFO

static final Set<DebuggingInfo> DEFAULT_DEBUGGING_INFO

Default debugging info to include in the compilation (all possible info).

DEFAULT_PARAMETER_INFO_ENABLED

static final boolean DEFAULT_PARAMETER_INFO_ENABLED

Default preference for including reflective parameter information in compiled classes (true).

See Also:

• Constant Field Values

Method Details

compile

JctCompilation compile(Workspace workspace)

Invoke the compilation and return the compilation result.

The actual classes to compile will be dynamically discovered. If you wish to specify the specific classes to compile, see compile(Workspace, String...) or compile(Workspace, Collection).

Parameters:

workspace - the workspace to compile.

Returns:

the compilation result.

Throws:

JctCompilerException - if the compiler threw an unhandled exception. This should not occur for compilation failures generally.

IllegalStateException - if no compilation units were found.

UncheckedIOException - if an IO error occurs.

See Also:

• compile(Workspace, String...)
• compile(Workspace, Collection)

compile

default JctCompilation compile(Workspace workspace,
 String... classNames)

Invoke the compilation and return the compilation result.

Only classes matching the given class names will be compiled.

If you wish to let JCT determine which classes to compile dynamically, see compile(Workspace) instead.

Note that nested instance/static nested classes cannot be specified individually here. To compile them, you must also compile their outer class that they are defined within.

Parameters:

workspace - the workspace to compile.

classNames - the class names to compile.

Returns:

the compilation result.

Throws:

JctCompilerException - if the compiler threw an unhandled exception. This should not occur for compilation failures generally.

NullPointerException - if any class names are null, or if the array is null.

IllegalStateException - if no compilation units were found.

UncheckedIOException - if an IO error occurs.

See Also:

• compile(Workspace)
• compile(Workspace, Collection)

compile

JctCompilation compile(Workspace workspace,
 Collection<String> classNames)

Invoke the compilation and return the compilation result.

Only classes matching the given class names will be compiled.

If you wish to let JCT determine which classes to compile dynamically, see compile(Workspace) instead.

Note that nested instance/static nested classes cannot be specified individually here. To compile them, you must also compile their outer class that they are defined within.

Parameters:

workspace - the workspace to compile.

classNames - the class names to compile.

Returns:

the compilation result.

Throws:

JctCompilerException - if the compiler threw an unhandled exception. This should not occur for compilation failures usually.

NullPointerException - if the classNames collection contains any null values, or if the collection itself is null.

IllegalArgumentException - if the collection is empty.

IllegalStateException - if no compilation units were found.

UncheckedIOException - if an IO error occurs.

See Also:

• compile(Workspace)
• compile(Workspace, String...)

configure

<E extends Exception> JctCompiler configure(JctCompilerConfigurer<E> configurer)
                                     throws E

Apply a given configurer to this compiler.

Configurers can be lambdas, method references, or objects.

   // Using an object configurer
   var werrorConfigurer = new JctCompilerConfigurer<RuntimeException>() {
     @Override
     public void configure(JctCompiler compiler) {
       compiler.failOnWarnings(true);
     }
   };
   compiler.configure(werrorConfigurer);

   // Using a lambda configurer
   compiler.configure(c -> c.verbose(true));
 

Configurers take a type parameter that corresponds to an exception type. This is the exception type that can be thrown by the configurer, or RuntimeException if no checked exception is thrown. This mechanism allows configurers to propagate checked exceptions to their caller where needed.

   class FileFlagConfigurer implements JctCompilerConfigurer<IOException> {
     private final Path path;

     public FileFlagConfigurer(String... path) {
       this(Path.of(path));
     }

     public FileFlagConfigurer(Path path) {
       this.path = path;
     }

     @Override
     public void configure(JctCompiler compiler) throws IOException {
       var flags = Files.lines(path)
           .map(String::trim)
           .filter(not(String::isBlank))
           .toList();
       compiler.addCompilerOptions(flags);
     }
   }

   @Test
   void testSomething() throws IOException {
     ...
     compiler.configure(new FileFlagConfigurer("src", "test", "resources", "flags.txt"));
     ...
   }
 

Type Parameters:

E - any exception that may be thrown.

Parameters:

configurer - the configurer to invoke.

Returns:

this compiler object for further call chaining.

Throws:

E - any exception that may be thrown by the configurer. If no checked exception is thrown, then this should be treated as RuntimeException.

getName

String getName()

Get the friendly printable name of this compiler object.

Returns:

the name of the compiler.

name

JctCompiler name(String name)

Set the friendly name of this compiler.

This will be used by the JUnit5 support to name unit test cases.

Parameters:

name - the name to set.

Returns:

this compiler object for further call chaining.

getAnnotationProcessorOptions

List<String> getAnnotationProcessorOptions()

Get an immutable snapshot view of the current annotation processor options that are set.

Returns:

the current annotation processor options that are set.

addAnnotationProcessorOptions

JctCompiler addAnnotationProcessorOptions(Iterable<String> annotationProcessorOptions)

Add options to pass to any annotation processors.

Parameters:

annotationProcessorOptions - the options to pass.

Returns:

this compiler object for further call chaining.

addAnnotationProcessorOptions

default JctCompiler addAnnotationProcessorOptions(String... annotationProcessorOptions)

Add options to pass to any annotation processors.

Parameters:

annotationProcessorOptions - options to pass.

Returns:

this compiler object for further call chaining.

getAnnotationProcessors

List<Processor> getAnnotationProcessors()

Get an immutable snapshot view of the current annotation processors that are explicitly set to be run, in the order that they were provided to the compiler.

Returns:

the current annotation processors that are set.

addAnnotationProcessors

JctCompiler addAnnotationProcessors(Iterable<? extends Processor> annotationProcessors)

Add annotation processors to invoke.

Warning: This bypasses the discovery process of annotation processors provided in the annotation processor path and annotation processor module paths, as well as any other locations such as class paths and module paths.

Parameters:

annotationProcessors - the processors to invoke.

Returns:

this compiler object for further call chaining.

addAnnotationProcessors

default JctCompiler addAnnotationProcessors(Processor... annotationProcessors)

Add annotation processors to invoke.

Warning: This bypasses the discovery process of annotation processors provided in the annotation processor path and annotation processor module paths, as well as any other locations such as class paths and module paths.

Parameters:

annotationProcessors - processors to invoke.

Returns:

this compiler object for further call chaining.

getCompilerOptions

List<String> getCompilerOptions()

Get an immutable snapshot view of the current compiler options that are set.

Returns:

the current compiler options that are set.

addCompilerOptions

JctCompiler addCompilerOptions(Iterable<String> compilerOptions)

Add command line options to pass to javac.

Parameters:

compilerOptions - the options to add.

Returns:

this compiler object for further call chaining.

addCompilerOptions

default JctCompiler addCompilerOptions(String... compilerOptions)

Add command line options to pass to javac.

Parameters:

compilerOptions - options to add.

Returns:

this compiler object for further call chaining.

isVerbose

boolean isVerbose()

Determine whether verbose logging is enabled or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_VERBOSE.

Note that enabling this is compiler-specific behaviour. There is no guarantee that the output target or the format or verbosity of output will be consistent between different compiler implementations.

Returns:

whether verbose logging is enabled or not.

verbose

JctCompiler verbose(boolean enabled)

Set whether to use verbose output or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_VERBOSE.

Note that enabling this is compiler-specific behaviour. There is no guarantee that the output target or the format or verbosity of output will be consistent between different compiler implementations.

Parameters:

enabled - true for verbose output, false for normal output.

Returns:

this compiler for further call chaining.

isPreviewFeatures

boolean isPreviewFeatures()

Determine whether preview features are enabled or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_PREVIEW_FEATURES.

Returns:

whether preview features are enabled or not.

previewFeatures

JctCompiler previewFeatures(boolean enabled)

Set whether to enable compiler preview features or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_PREVIEW_FEATURES.

Generally, this feature should be avoided if testing across multiple versions of Java, as preview features are often not finalised and may change without warning.

Parameters:

enabled - true to enable preview features, or false to disable them.

Returns:

this compiler object for further call chaining.

isShowWarnings

boolean isShowWarnings()

Determine whether warnings are enabled or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_SHOW_WARNINGS.

Returns:

whether warnings are enabled or not.

showWarnings

JctCompiler showWarnings(boolean enabled)

Set whether to enable displaying warnings or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_SHOW_WARNINGS.

Parameters:

enabled - true to enable warnings. false to disable them.

Returns:

this compiler object for further call chaining.

isShowDeprecationWarnings

boolean isShowDeprecationWarnings()

Determine whether deprecation warnings are enabled or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_SHOW_DEPRECATION_WARNINGS.

Returns:

whether deprecation warnings are enabled or not.

showDeprecationWarnings

JctCompiler showDeprecationWarnings(boolean enabled)

Set whether to enable deprecation warnings or not.

This is ignored if showWarnings(boolean) is disabled.

Unless otherwise changed or specified, implementations should default to DEFAULT_SHOW_DEPRECATION_WARNINGS.

Parameters:

enabled - true to enable deprecation warnings. false to disable them.

Returns:

this compiler object for further call chaining.

isFailOnWarnings

boolean isFailOnWarnings()

Determine whether warnings are being treated as errors or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_FAIL_ON_WARNINGS.

Returns:

whether warnings are being treated as errors or not.

failOnWarnings

JctCompiler failOnWarnings(boolean enabled)

Set whether to enable treating warnings as errors or not.

Some compilers may call this flag something different, such as "-Werror".

This is ignored if showWarnings(boolean) is disabled.

Unless otherwise changed or specified, implementations should default to DEFAULT_FAIL_ON_WARNINGS.

Parameters:

enabled - true to enable treating warnings as errors. false to disable them.

Returns:

this compiler object for further call chaining.

getCompilationMode

CompilationMode getCompilationMode()

Get the compilation mode that is in use.

Unless otherwise changed or specified, implementations should default to DEFAULT_COMPILATION_MODE.

Returns:

the compilation mode.

compilationMode

JctCompiler compilationMode(CompilationMode compilationMode)

Set the compilation mode to use for this compiler.

This allows you to override whether sources are compiled or annotation-processed without running the full compilation process. Tuning this may provide faster test cases in some situations.

Unless otherwise changed or specified, implementations should default to DEFAULT_COMPILATION_MODE.

Parameters:

compilationMode - the compilation mode to use.

Returns:

this compiler object for further call chaining.

getDefaultRelease

String getDefaultRelease()

Get the default release to use if no release or target version is specified.

This can not be configured generally, as it is defined by the internal compiler implementation.

Generally, this value will be an integer within a string. The value is represented as a string to allow supporting compilers which may use non-integer version numbers.

Returns:

the default release version to use.

getEffectiveRelease

String getEffectiveRelease()

Get the effective release to use for the actual compilation.

Generally, this value will be an integer within a string. The value is represented as a string to allow supporting compilers which may use non-integer version numbers.

This may be determined from the source, target, release, and default release.

Returns:

the effective release.

getRelease

@Nullable String getRelease()

Get the current release version that is set, or null if left to the compiler to decide. default.

Generally, this value will be an integer within a string. The value is represented as a string to allow supporting compilers which may use non-integer version numbers.

Unless explicitly defined, the default setting is expected to be a sane compiler-specific default.

Returns:

the release version string, if set.

release

JctCompiler release(@Nullable String release)

Set the release version.

This will clear any source and target version that is set.

Generally, this value will be an integer within a string. The value is represented as a string to allow supporting compilers which may use non-integer version numbers.

Unless explicitly defined, the default setting is expected to be a sane compiler-specific default.

Parameters:

release - the version to set.

Returns:

this compiler object for further call chaining.

release

default JctCompiler release(int release)

Set the release version.

This will clear any source and target version that is set.

Generally, this value will be an integer within a string. The value is represented as a string to allow supporting compilers which may use non-integer version numbers.

Unless explicitly defined, the default setting is expected to be a sane compiler-specific default.

Parameters:

release - the version to set.

Returns:

this compiler object for further call chaining.

Throws:

IllegalArgumentException - if the version is less than 0.

UnsupportedOperationException - if the compiler does not support integer versions.

release

default JctCompiler release(SourceVersion release)

Set the release version.

This will clear any source and target version that is set.

Generally, this value will be an integer within a string. The value is represented as a string to allow supporting compilers which may use non-integer version numbers.

Unless explicitly defined, the default setting is expected to be a sane compiler-specific default.

Parameters:

release - the version to set.

Returns:

this compiler object for further call chaining.

Throws:

UnsupportedOperationException - if the compiler does not support integer versions.

NullPointerException - if the release is null.

useRuntimeRelease

@API(since="1.1.0",
     status=STABLE)
default JctCompiler useRuntimeRelease()

Request that the compiler uses a language version that corresponds to the runtime language version in use on the current JVM.

For example, running this on JRE 19 would set the release to "19".

This calls release(int) internally.

Returns:

this compiler object for further call chaining.

Throws:

UnsupportedOperationException - if the current JVM version does not correspond to a supported Java release version in the compiler, or if the compiler does not support integral version numbers.

Since:

1.1.0

getSource

@Nullable String getSource()

Get the current source version that is set, or null if left to the compiler to decide. default.

Unless explicitly defined, the default setting is expected to be a sane compiler-specific default.

Returns:

the source version string, if set.

source

JctCompiler source(@Nullable String source)

Set the source version.

This will clear any release version that is set.

Unless explicitly defined, the default setting is expected to be a sane compiler-specific default.

Source and target versions have mostly been replaced with the release version mechanism which controls both flags and can ensure other behaviours are consistent. This feature is still provided in case you have a specific use case that is not covered by this functionality.

Parameters:

source - the version to set.

Returns:

this compiler object for further call chaining.

source

default JctCompiler source(int source)

Set the source version.

This will clear any release version that is set.

Unless explicitly defined, the default setting is expected to be a sane compiler-specific default.

Source and target versions have mostly been replaced with the release version mechanism which controls both flags and can ensure other behaviours are consistent. This feature is still provided in case you have a specific use case that is not covered by this functionality.

Parameters:

source - the version to set.

Returns:

this compiler object for further call chaining.

Throws:

IllegalArgumentException - if the version is less than 0.

UnsupportedOperationException - if the compiler does not support integer versions.

source

default JctCompiler source(SourceVersion source)

Set the source version.

This will clear any release version that is set.

Unless explicitly defined, the default setting is expected to be a sane compiler-specific default.

Source and target versions have mostly been replaced with the release version mechanism which controls both flags and can ensure other behaviours are consistent. This feature is still provided in case you have a specific use case that is not covered by this functionality.

Parameters:

source - the version to set.

Returns:

this compiler object for further call chaining.

Throws:

UnsupportedOperationException - if the compiler does not support integer versions.

NullPointerException - if the source is null.

getTarget

@Nullable String getTarget()

Get the current target version that is set, or null if left to the compiler default.

Unless explicitly defined, the default setting is expected to be a sane compiler-specific default.

Returns:

the target version string, if set.

target

JctCompiler target(@Nullable String target)

Set the target version.

This will clear any release version that is set.

Unless explicitly defined, the default setting is expected to be a sane compiler-specific default.

Source and target versions have mostly been replaced with the release version mechanism which controls both flags and can ensure other behaviours are consistent. This feature is still provided in case you have a specific use case that is not covered by this functionality.

Parameters:

target - the version to set.

Returns:

this compiler object for further call chaining.

target

default JctCompiler target(int target)

Set the target version.

This will clear any release version that is set.

Unless explicitly defined, the default setting is expected to be a sane compiler-specific default.

Source and target versions have mostly been replaced with the release version mechanism which controls both flags and can ensure other behaviours are consistent. This feature is still provided in case you have a specific use case that is not covered by this functionality.

Parameters:

target - the version to set.

Returns:

this compiler object for further call chaining.

Throws:

IllegalArgumentException - if the version is less than 0.

UnsupportedOperationException - if the compiler does not support integer versions.

target

default JctCompiler target(SourceVersion target)

Set the target version.

This will clear any release version that is set.

Unless explicitly defined, the default setting is expected to be a sane compiler-specific default.

Source and target versions have mostly been replaced with the release version mechanism which controls both flags and can ensure other behaviours are consistent. This feature is still provided in case you have a specific use case that is not covered by this functionality.

Parameters:

target - the version to set.

Returns:

this compiler object for further call chaining.

Throws:

UnsupportedOperationException - if the compiler does not support integer versions.

NullPointerException - if the target is null.

isFixJvmModulePathMismatch

boolean isFixJvmModulePathMismatch()

Get whether we will attempt to fix modules appearing on the classpath, or non-modules appearing on the module path.

This enables correct classpath and module path detection when the test pack is a module but the code being compiled in the test is not, and vice versa. We need this because many build systems decide whether to populate the --module-path or the --classpath with JPMS-enabled dependencies based on whether the project under compilation is a JPMS module itself.

This only applies if isInheritModulePath() or isInheritClassPath() is enabled, and only applies to the current JVM classpath and module path.

Unless otherwise changed or specified, implementations should default to DEFAULT_FIX_JVM_MODULE_PATH_MISMATCH.

Returns:

true if enabled, or false if disabled.

fixJvmModulePathMismatch

JctCompiler fixJvmModulePathMismatch(boolean fixJvmModulePathMismatch)

Get whether we will attempt to fix modules appearing on the classpath, or non-modules appearing on the module path.

Unless otherwise changed or specified, implementations should default to DEFAULT_FIX_JVM_MODULE_PATH_MISMATCH.

Parameters:

fixJvmModulePathMismatch - whether to enable the mismatch fixing or not.

Returns:

this compiler object for further call chaining.

isInheritClassPath

boolean isInheritClassPath()

Get whether the class path is inherited from the active JVM or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_INHERIT_CLASS_PATH.

Returns:

whether the current class path is being inherited or not.

inheritClassPath

JctCompiler inheritClassPath(boolean inheritClassPath)

Set whether the class path is inherited from the active JVM or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_INHERIT_CLASS_PATH.

Parameters:

inheritClassPath - true to include it, or false to exclude it.

Returns:

this compiler object for further call chaining.

isInheritModulePath

boolean isInheritModulePath()

Get whether the module path is inherited from the active JVM or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_INHERIT_MODULE_PATH.

Returns:

whether the module path is being inherited or not.

inheritModulePath

JctCompiler inheritModulePath(boolean inheritModulePath)

Set whether the module path is inherited from the active JVM or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_INHERIT_MODULE_PATH.

Parameters:

inheritModulePath - true to include it, or false to exclude it.

Returns:

this compiler object for further call chaining.

isInheritSystemModulePath

boolean isInheritSystemModulePath()

Get whether the system module path is inherited from the active JVM or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_INHERIT_SYSTEM_MODULE_PATH.

Returns:

whether the system module path is being inherited or not.

inheritSystemModulePath

JctCompiler inheritSystemModulePath(boolean inheritSystemModulePath)

Set whether the system module path is inherited from the active JVM or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_INHERIT_SYSTEM_MODULE_PATH.

Parameters:

inheritSystemModulePath - true to include it, or false to exclude it.

Returns:

this compiler object for further call chaining.

getLocale

Locale getLocale()

Get the output locale.

Unless otherwise changed or specified, implementations should default to DEFAULT_LOCALE.

Returns:

the output locale to use.

locale

JctCompiler locale(Locale locale)

Set the output locale.

Unless otherwise changed or specified, implementations should default to DEFAULT_LOCALE.

Parameters:

locale - the locale to use.

Returns:

this compiler for further call chaining.

getLogCharset

Charset getLogCharset()

Get the charset being used to write compiler logs with.

Unless otherwise changed or specified, implementations should default to DEFAULT_LOG_CHARSET.

Returns:

the charset.

logCharset

JctCompiler logCharset(Charset logCharset)

Set the charset being used to write compiler logs with.

Unless otherwise changed or specified, implementations should default to DEFAULT_LOG_CHARSET.

Parameters:

logCharset - the charset to use.

Returns:

this compiler for further call chaining.

getFileManagerLoggingMode

LoggingMode getFileManagerLoggingMode()

Get the current file manager logging mode.

Unless otherwise changed or specified, implementations should default to DEFAULT_FILE_MANAGER_LOGGING_MODE.

Returns:

the current file manager logging mode.

fileManagerLoggingMode

JctCompiler fileManagerLoggingMode(LoggingMode fileManagerLoggingMode)

Set how to handle logging calls to underlying file managers.

Unless otherwise changed or specified, implementations should default to DEFAULT_FILE_MANAGER_LOGGING_MODE.

Parameters:

fileManagerLoggingMode - the mode to use for file manager logging.

Returns:

this compiler for further call chaining.

getDiagnosticLoggingMode

LoggingMode getDiagnosticLoggingMode()

Get the current diagnostic logging mode.

Unless otherwise changed or specified, implementations should default to DEFAULT_DIAGNOSTIC_LOGGING_MODE.

Returns:

the current diagnostic logging mode.

diagnosticLoggingMode

JctCompiler diagnosticLoggingMode(LoggingMode diagnosticLoggingMode)

Set how to handle diagnostic capture.

Unless otherwise changed or specified, implementations should default to DEFAULT_DIAGNOSTIC_LOGGING_MODE.

Parameters:

diagnosticLoggingMode - the mode to use for diagnostic capture.

Returns:

this compiler for further call chaining.

getAnnotationProcessorDiscovery

AnnotationProcessorDiscovery getAnnotationProcessorDiscovery()

Get how to perform annotation processor discovery.

Unless otherwise changed or specified, implementations should default to DEFAULT_ANNOTATION_PROCESSOR_DISCOVERY.

Specifying any annotation processors explicitly with addAnnotationProcessors(Iterable) or addAnnotationProcessors(Processor...) will bypass this setting, treating it as being disabled.

Returns:

the processor discovery mode to use.

annotationProcessorDiscovery

JctCompiler annotationProcessorDiscovery(AnnotationProcessorDiscovery annotationProcessorDiscovery)

Set how to perform annotation processor discovery.

Unless otherwise changed or specified, implementations should default to DEFAULT_ANNOTATION_PROCESSOR_DISCOVERY.

Specifying any annotation processors explicitly with addAnnotationProcessors(Iterable) or addAnnotationProcessors(Processor...) will bypass this setting, treating it as being disabled.

Parameters:

annotationProcessorDiscovery - the processor discovery mode to use.

Returns:

this compiler for further call chaining.

getDebuggingInfo

Set<DebuggingInfo> getDebuggingInfo()

Get the debugging info that is enabled.

Unless otherwise changed or specified, implementations should default to DEFAULT_DEBUGGING_INFO.

Returns:

the set of debugging info flags that are enabled.

Since:

3.0.0

debuggingInfo

JctCompiler debuggingInfo(Set<DebuggingInfo> debuggingInfoFlags)

Set the debugging info level to use.

Parameters:

debuggingInfoFlags - the set of debugging info flags to enable.

Returns:

this compiler for further call chaining.

Since:

3.0.0

isParameterInfoEnabled

boolean isParameterInfoEnabled()

Determine if including reflective parameter info is enabled or not.

Unless otherwise changed or specified, implementations should default to DEFAULT_PARAMETER_INFO_ENABLED.

Returns:

the parameter info inclusion preference.

Since:

3.0.0

parameterInfoEnabled

JctCompiler parameterInfoEnabled(boolean parameterInfoEnabled)

Set whether to include parameter reflective info by default in compiled classes or not.

Parameters:

parameterInfoEnabled - whether to include the parameter reflective info or not.

Returns:

this compiler for further call chaining.

Since:

3.0.0