dev.jeka.core.api.project

Class JkProjectCompilation

java.lang.Object

dev.jeka.core.api.project.JkProjectCompilation

public class JkProjectCompilation
extends java.lang.Object

Handles project compilation step. Users can configure inner phases by chaining runnables. They also can modify JkJavaCompilerToolChain and JkJavaCompileSpec to use.

Field Summary

Fields

Modifier and Type	Field and Description
JkDependencySetModifier	dependencies
static java.lang.String	JAVA_SOURCES_COMPILE_ACTION
JkCompileLayout	layout
JkRunnables	postCompileActions The JkRunnables to be run after compilation.
JkRunnables	preCompileActions The JkRunnables to run after source and resource generation.
JkResourceProcessor	resourceProcessor
static java.lang.String	RESOURCES_PROCESS_ACTION

Method Summary

Modifier and Type	Method and Description
JkProjectCompilation	addJavaCompilerOptions(java.lang.String... options) Adds options to be passed to Java compiler
JkProjectCompilation	addSourceGenerator(JkProjectSourceGenerator sourceGenerator) Adds a source generator responsible for generating source files to the project compilation process.
JkProjectCompilation	addSourceGenerator(java.lang.String generatorName, java.util.function.BiConsumer<JkProject,java.nio.file.Path> generator) Adds a source generator responsible for generating source files to the project compilation process.
JkProjectCompilation	addSourceGenerator(java.lang.String generatorName, java.util.function.Consumer<java.nio.file.Path> generator) Adds a source generator responsible for generating source files to the project compilation process.
JkProjectCompilation	apply(java.util.function.Consumer<JkProjectCompilation> consumer)
protected JkDependencySet	baseDependencies()
protected JkPathSequence	classpath()
void	generateSources()
java.util.List<java.lang.String>	getExtraJavaCompilerOptions() Returns extra compile options passed to the compiler
java.util.List<java.nio.file.Path>	getGeneratedSourceDirs()
protected JkCompileLayout	initialLayout()
boolean	isDone()
protected java.lang.String	purpose()
java.util.List<java.nio.file.Path>	resolveDependenciesAsFiles()
void	run() Performs entire compilation phase.
void	runIfNeeded() As #run but perform only if not already done.
void	skipJavaCompilation()

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCES_PROCESS_ACTION

public static final java.lang.String RESOURCES_PROCESS_ACTION

See Also:

Constant Field Values

JAVA_SOURCES_COMPILE_ACTION

public static final java.lang.String JAVA_SOURCES_COMPILE_ACTION

See Also:

Constant Field Values

preCompileActions

public final JkRunnables preCompileActions

The JkRunnables to run after source and resource generation. User can chain its own runnable to customise the process. Contains RESOURCES_PROCESS_ACTION by default

postCompileActions

public final JkRunnables postCompileActions

The JkRunnables to be run after compilation. User can chain its own runnable to customise the process. Empty by default.

resourceProcessor

public final JkResourceProcessor resourceProcessor

layout

public final JkCompileLayout layout

dependencies

public final JkDependencySetModifier dependencies

Method Detail

apply

public JkProjectCompilation apply(java.util.function.Consumer<JkProjectCompilation> consumer)

generateSources

public void generateSources()

run

public void run()

Performs entire compilation phase.

runIfNeeded

public void runIfNeeded()

As #run but perform only if not already done.

skipJavaCompilation

public void skipJavaCompilation()

getExtraJavaCompilerOptions

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

Returns extra compile options passed to the compiler

addJavaCompilerOptions

public JkProjectCompilation addJavaCompilerOptions(java.lang.String... options)

Adds options to be passed to Java compiler

resolveDependenciesAsFiles

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

addSourceGenerator

public JkProjectCompilation addSourceGenerator(JkProjectSourceGenerator sourceGenerator)

Adds a source generator responsible for generating source files to the project compilation process.

Parameters:

sourceGenerator - the JkProjectSourceGenerator instance used for generating sources

Returns:

the current instance of JkProjectCompilation to allow method chaining

addSourceGenerator

public JkProjectCompilation addSourceGenerator(java.lang.String generatorName,
                                               java.util.function.BiConsumer<JkProject,java.nio.file.Path> generator)

Adds a source generator responsible for generating source files to the project compilation process. The generator is defined by a name and a BiConsumer action that takes a JkProject and a Path representing the generated source directory.

Parameters:

generatorName - the name assigned to the source generator

generator - a BiConsumer defining the generation behavior by taking a JkProject instance and the directory where sources will be generated

Returns:

the current instance of JkProjectCompilation to allow method chaining

addSourceGenerator

public JkProjectCompilation addSourceGenerator(java.lang.String generatorName,
                                               java.util.function.Consumer<java.nio.file.Path> generator)

Adds a source generator responsible for generating source files to the project compilation process. The generator is defined by a name and an action that takes a directory where sources will be generated.

Parameters:

generatorName - the name assigned to the source generator

generator - a Consumer defining the generation behavior by accepting the directory where sources will be generated

Returns:

the current instance of JkProjectCompilation to allow method chaining

isDone

public boolean isDone()

getGeneratedSourceDirs

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

initialLayout

protected JkCompileLayout initialLayout()

classpath

protected JkPathSequence classpath()

baseDependencies

protected JkDependencySet baseDependencies()

purpose

protected java.lang.String purpose()