dev.jeka.core.api.java

Class JkJavaCompileSpec

java.lang.Object

dev.jeka.core.api.java.JkJavaCompileSpec

public final class JkJavaCompileSpec
extends java.lang.Object

Stands for a compilation settings as source and target version, encoding, annotation processing or any option supported by the compileRunner.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENCODING_OPTS
static java.lang.String	PROCESSOR_OPTS
static java.lang.String	RELEASE_OPTS
static java.lang.String	SOURCE_OPTS
static java.lang.String	TARGET_OPTS

Method Summary

Modifier and Type	Method and Description
JkJavaCompileSpec	addOptions(java.lang.Iterable<java.lang.String> options) See addOptions(String...)
JkJavaCompileSpec	addOptions(java.lang.String... options) Adds specified options to pass to the compileRunner.
JkJavaCompileSpec	copy()
JkJavaCompileSpec	disableAnnotationProcessing() Disable annotation processing.
JkPathSequence	getClasspath()
java.lang.String	getEncoding()
java.lang.String	getNextValue(java.lang.String optionName)
java.util.List<java.lang.String>	getOptions() Returns the specifications as a list of string directly usable in the JkJavaCompilerToolChain except source path
java.nio.file.Path	getOutputDir()
java.lang.String	getReleaseVersion()
java.util.List<java.nio.file.Path>	getSourceDirs()
JkPathTreeSet	getSources()
java.lang.String	getSourceVersion()
java.lang.String	getTargetVersion()
JkJavaVersion	minJavaVersion() Returns the minimum version of Java suitable for compiling, according source, target and release options.
static JkJavaCompileSpec	of()
JkJavaCompileSpec	setAnnotationProcessingOnly() Only process annotation.
JkJavaCompileSpec	setAnnotationProcessors(java.lang.String... annotationProcessorClassNames) Sets specified annotation classes instead of using the ones discovered by default Java 6 mechanism.
JkJavaCompileSpec	setClasspath(java.lang.Iterable<java.nio.file.Path> files) Set the compiler classpath with the specified files
JkJavaCompileSpec	setEncoding(java.lang.String encoding) Creates a copy of this JkJavaCompileSpec but using the specified source encoding (e.g.
JkJavaCompileSpec	setOption(java.lang.String optionName, java.lang.String optionValue) Some options of a compileRunner are set in a couple of name/value (version, classpath, .....).
JkJavaCompileSpec	setOutputDir(java.nio.file.Path outputDir)
JkJavaCompileSpec	setReleaseVersion(java.lang.String version) Sets option -release
JkJavaCompileSpec	setSources(java.util.function.Function<JkPathTreeSet,JkPathTreeSet> modifier) Adds specified source files to the set of java sources to compile.
JkJavaCompileSpec	setSources(JkPathTreeSet sources)
JkJavaCompileSpec	setSourceVersion(java.lang.String version) Sets option -source
JkJavaCompileSpec	setTargetVersion(java.lang.String version) Sets option -target

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SOURCE_OPTS

public static final java.lang.String SOURCE_OPTS

See Also:

Constant Field Values

TARGET_OPTS

public static final java.lang.String TARGET_OPTS

See Also:

Constant Field Values

RELEASE_OPTS

public static final java.lang.String RELEASE_OPTS

See Also:

Constant Field Values

PROCESSOR_OPTS

public static final java.lang.String PROCESSOR_OPTS

See Also:

Constant Field Values

ENCODING_OPTS

public static final java.lang.String ENCODING_OPTS

See Also:

Constant Field Values

Method Detail

of

public static JkJavaCompileSpec of()

copy

public JkJavaCompileSpec copy()

getOptions

public java.util.List<java.lang.String> getOptions()

Returns the specifications as a list of string directly usable in the JkJavaCompilerToolChain except source path

getOutputDir

public java.nio.file.Path getOutputDir()

setOutputDir

public JkJavaCompileSpec setOutputDir(java.nio.file.Path outputDir)

getSourceVersion

public java.lang.String getSourceVersion()

getReleaseVersion

public java.lang.String getReleaseVersion()

getTargetVersion

public java.lang.String getTargetVersion()

minJavaVersion

public JkJavaVersion minJavaVersion()

Returns the minimum version of Java suitable for compiling, according source, target and release options.

Returns null if none of these options is present.

setSourceVersion

public JkJavaCompileSpec setSourceVersion(java.lang.String version)

Sets option -source

setTargetVersion

public JkJavaCompileSpec setTargetVersion(java.lang.String version)

Sets option -target

setReleaseVersion

public JkJavaCompileSpec setReleaseVersion(java.lang.String version)

Sets option -release

getEncoding

public java.lang.String getEncoding()

setEncoding

public JkJavaCompileSpec setEncoding(java.lang.String encoding)

Creates a copy of this JkJavaCompileSpec but using the specified source encoding (e.g. UTF-8). If null is specified, then default plateform encoding will be used.

setSources

public JkJavaCompileSpec setSources(java.util.function.Function<JkPathTreeSet,JkPathTreeSet> modifier)

Adds specified source files to the set of java sources to compile.

setSources

public JkJavaCompileSpec setSources(JkPathTreeSet sources)

getSources

public JkPathTreeSet getSources()

getSourceDirs

public java.util.List<java.nio.file.Path> getSourceDirs()

setClasspath

public JkJavaCompileSpec setClasspath(java.lang.Iterable<java.nio.file.Path> files)

Set the compiler classpath with the specified files

getClasspath

public JkPathSequence getClasspath()

addOptions

public JkJavaCompileSpec addOptions(java.lang.String... options)

Adds specified options to pass to the compileRunner. Options are option you pass in javac command line as -deprecation, -nowarn, ... For example, if you want something equivalent to javac -deprecation -cp path1 path2, you should pass "-deprecation", "-cp", "path1", "path2" parameters.

addOptions

public JkJavaCompileSpec addOptions(java.lang.Iterable<java.lang.String> options)

See addOptions(String...)

setOption

public JkJavaCompileSpec setOption(java.lang.String optionName,
                                   java.lang.String optionValue)

Some options of a compileRunner are set in a couple of name/value (version, classpath, .....). So if you want to explicitly set such an option it is desirable to remove current value instead of adding it at the queue of options. This method does this for you.

setAnnotationProcessors

public JkJavaCompileSpec setAnnotationProcessors(java.lang.String... annotationProcessorClassNames)

Sets specified annotation classes instead of using the ones discovered by default Java 6 mechanism.

disableAnnotationProcessing

public JkJavaCompileSpec disableAnnotationProcessing()

Disable annotation processing.

setAnnotationProcessingOnly

public JkJavaCompileSpec setAnnotationProcessingOnly()

Only process annotation.

getNextValue

public java.lang.String getNextValue(java.lang.String optionName)