Class JavaCompiler

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.AbstractGenerator

org.jdrupes.builder.java.JavaTool

org.jdrupes.builder.java.JavaCompiler

All Implemented Interfaces:

Generator, Renamable, ResourceProvider

public class JavaCompiler
extends JavaTool

The JavaCompiler generator provides two types of resources.

1. The JavaSourceFiles of the project as configured with addSources(FileTree) in response to a ResourceRequest with ResourceType JavaTypes.JavaSourceTreeType (or a more general type).

2. The ClassFiles that result from compiling the sources in response to a ResourceRequest with ResourceType JavaTypes.ClassTreeType (or a more general type such as JavaTypes.CodeContributionType).

No attempt has been made to define types for the options of the java compiler. Rather, the options are passed as strings as the ToolProvider API suggests. There are some noteworthy exceptions for options that are directly related to resource types (files, directory trees, paths) from the builder context.

If no "-g..." option is specified, the generator adds "-g" and thus generates full debug information. If you want to restore the default behavior of the java compiler, you have to specify "-g:[lines, source]" explicitly.

JPMS support

When the sources contain a module-info.java, or when the module mode is set to ModuleMode.MODULE, compilation uses the module-path (--module-path) for code contributions that contain a module descriptor. Non-modular code contributions remain on the classpath (-cp). In ModuleMode.AUTO mode (the default), module compilation is activated automatically when a module-info.java is found among the sources.

Nested Class Summary

Nested classes/interfaces inherited from class JavaTool

JavaTool.ModuleMode

Constructor Summary

Constructors

Constructor	Description
JavaCompiler(Project project)	Initializes a new java compiler.

Method Summary

Modifier and Type	Method	Description
final JavaCompiler	addSources(Path directory, String pattern)	Adds the files from the given directory matching the given pattern.
final JavaCompiler	addSources(Stream<FileTree<JavaSourceFile>> sources)	Adds the sources.
final JavaCompiler	addSources(FileTree<JavaSourceFile> sources)	Adds the source tree.
Path	destination()	Returns the destination directory.
JavaCompiler	destination(Path destination)	Sets the destination directory.
protected <T extends Resource> Collection<T>	doProvide(ResourceRequest<T> requested)	Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.
protected boolean	hasModuleInfo()	Checks whether a module-info.java exists among the configured sources.
Resources<FileTree<JavaSourceFile>>	sources()	Returns the source trees configured for the compiler.

Methods inherited from class JavaTool

effectiveModuleMode, logDiagnostic, logDiagnostics, moduleMode, moduleMode, optionArgument, options, options, options

Methods inherited from class AbstractGenerator

cleanup, name, project, toString

Methods inherited from class AbstractProvider

context, name, of, rename, vavrStream

Methods inherited from class Object

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

Methods inherited from interface ResourceProvider

context, name, of, resources

Constructor Details

JavaCompiler

public JavaCompiler(Project project)

Initializes a new java compiler.

Parameters:

project - the project

Method Details

destination

public Path destination()

Returns the destination directory. Defaults to "classes" for "normal" projects and to "test-classes" for projects that implement the MergedTestProject interface.

Returns:

the destination

destination

public JavaCompiler destination(Path destination)

Sets the destination directory. The Path is resolved against the project's build directory (see Project.buildDirectory()).

Parameters:

destination - the new destination

Returns:

the java compiler

addSources

public final JavaCompiler addSources(FileTree<JavaSourceFile> sources)

Adds the source tree.

Parameters:

sources - the sources

Returns:

the java compiler

addSources

public final JavaCompiler addSources(Path directory,
 String pattern)

Adds the files from the given directory matching the given pattern. Short for addSources(project().newFileTree(directory, pattern, JavaSourceFile.class)).

Parameters:

directory - the directory

pattern - the pattern

Returns:

the java compiler

addSources

public final JavaCompiler addSources(Stream<FileTree<JavaSourceFile>> sources)

Adds the sources.

Parameters:

sources - the sources

Returns:

the java compiler

sources

public Resources<FileTree<JavaSourceFile>> sources()

Returns the source trees configured for the compiler.

Returns:

the resources

hasModuleInfo

protected boolean hasModuleInfo()

Description copied from class: JavaTool

Checks whether a module-info.java exists among the configured sources.

Specified by:

hasModuleInfo in class JavaTool

Returns:

true, if module-info.java is present

doProvide

protected <T extends Resource> Collection<T> doProvide(ResourceRequest<T> requested)

Description copied from class: AbstractProvider

Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.

Specified by:

doProvide in class AbstractProvider

Type Parameters:

T - the generic type

Parameters:

requested - the request for resources

Returns:

the stream