Module io.github.ascopes.jct

Package io.github.ascopes.jct.compilers

Interface JctFlagBuilder

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

Interface for defining a common flag builder for compilers.

Author:

Ashley Scopes

Method Summary

Modifier and Type	Method	Description
JctFlagBuilder	annotationProcessorOptions(List<String> options)	Add annotation processor options.
List<String>	build()	Build the list of command line options to use.
JctFlagBuilder	compilationMode(CompilationMode compilationMode)	Set the compilation mode to run under.
JctFlagBuilder	compilerOptions(List<String> options)	Add additional command line options.
JctFlagBuilder	debuggingInfo(Set<DebuggingInfo> set)	Add the debugging info flags.
JctFlagBuilder	failOnWarnings(boolean enabled)	Set whether to treat warnings as errors or not.
JctFlagBuilder	parameterInfoEnabled(boolean enabled)	Specify whether to include parameter reflection info in the compiled classes.
JctFlagBuilder	previewFeatures(boolean enabled)	Add preview feature preferences.
JctFlagBuilder	release(@Nullable String version)	Add the release version.
JctFlagBuilder	showDeprecationWarnings(boolean enabled)	Add deprecation warning preferences.
JctFlagBuilder	showWarnings(boolean enabled)	Add warnings preferences.
JctFlagBuilder	source(@Nullable String version)	Add the source version.
JctFlagBuilder	target(@Nullable String version)	Add the target version.
JctFlagBuilder	verbose(boolean enabled)	Add output-verbosity preferences.

Method Details

verbose

JctFlagBuilder verbose(boolean enabled)

Add output-verbosity preferences.

Parameters:

enabled - whether the feature is enabled.

Returns:

this builder.

previewFeatures

JctFlagBuilder previewFeatures(boolean enabled)

Add preview feature preferences.

Parameters:

enabled - whether the feature is enabled.

Returns:

this builder.

showWarnings

JctFlagBuilder showWarnings(boolean enabled)

Add warnings preferences.

Parameters:

enabled - whether the feature is enabled.

Returns:

this builder.

failOnWarnings

JctFlagBuilder failOnWarnings(boolean enabled)

Set whether to treat warnings as errors or not.

Parameters:

enabled - whether to treat warnings as errors.

Returns:

this builder.

compilationMode

JctFlagBuilder compilationMode(CompilationMode compilationMode)

Set the compilation mode to run under.

Parameters:

compilationMode - the compilation mode to run under.

Returns:

this builder.

showDeprecationWarnings

JctFlagBuilder showDeprecationWarnings(boolean enabled)

Add deprecation warning preferences.

Parameters:

enabled - whether the feature is enabled.

Returns:

this builder.

release

JctFlagBuilder release(@Nullable String version)

Add the release version.

Parameters:

version - the release version, or null if not specified.

Returns:

this builder.

source

JctFlagBuilder source(@Nullable String version)

Add the source version.

Parameters:

version - the source version, or null if not specified.

Returns:

this builder.

target

JctFlagBuilder target(@Nullable String version)

Add the target version.

Parameters:

version - the target version, or null if not specified.

Returns:

this builder.

debuggingInfo

JctFlagBuilder debuggingInfo(Set<DebuggingInfo> set)

Add the debugging info flags.

Parameters:

set - the set of debugging info flags to enable.

Returns:

this builder.

Since:

3.0.0

parameterInfoEnabled

JctFlagBuilder parameterInfoEnabled(boolean enabled)

Specify whether to include parameter reflection info in the compiled classes.

Parameters:

enabled - whether the parameter info is enabled or not.

Returns:

this builder.

Since:

3.0.0

annotationProcessorOptions

JctFlagBuilder annotationProcessorOptions(List<String> options)

Add annotation processor options.

Parameters:

options - the annotation processor options to use.

Returns:

this builder.

compilerOptions

JctFlagBuilder compilerOptions(List<String> options)

Add additional command line options.

Parameters:

options - the additional commandline options to add.

Returns:

this builder.

build

List<String> build()

Build the list of command line options to use.

Returns:

the command line options to use.