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, ResourceProvider

public class JavaCompiler
extends JavaTool

The JavaCompiler generator provides two types of resources.

1. The JavaSourceFiles of the project as configured with addSources(org.jdrupes.builder.api.FileTree<org.jdrupes.builder.java.JavaSourceFile>) 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.ClasspathElementType).

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.

Field Summary

Fields inherited from class AbstractProvider

log

Constructor Summary

Constructors

Constructor	Description
JavaCompiler(Project project)	Instantiates 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> Stream<T>	doProvide(ResourceRequest<T> requested)	Invoked by AbstractProvider.provide(ResourceRequest) after checking if the invocation is allowed.
Resources<FileTree<JavaSourceFile>>	sources()	Return the source trees configured for the compiler.

Methods inherited from class JavaTool

logDiagnostic, logDiagnostics, optionArgument, options, options, options

Methods inherited from class AbstractGenerator

cleanup, name, name, newResource, project, toString

Methods inherited from class AbstractProvider

provide

Methods inherited from class Object

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

Methods inherited from interface ResourceProvider

provide

Constructor Details

JavaCompiler

public JavaCompiler(Project project)

Instantiates a new java compiler.

Parameters:

project - the project

Method Details

destination

public Path destination()

Returns the destination directory. Defaults to "classes".

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 resources collector

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()

Return the source trees configured for the compiler.

Returns:

the resources

doProvide

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

Description copied from class: AbstractProvider

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

Specified by:

doProvide in class AbstractProvider

Type Parameters:

T - the generic type

Parameters:

requested - the requested

Returns:

the stream