javax.tools

Interface JavaCompiler.CompilationTask

All Superinterfaces:

java.util.concurrent.Callable<java.lang.Boolean>

All Known Implementing Classes:

JavacTask

Enclosing interface:

JavaCompiler

public static interface JavaCompiler.CompilationTask
extends java.util.concurrent.Callable<java.lang.Boolean>

Interface representing a future for a compilation task. The compilation task has not yet started. To start the task, call the call method.

Before calling the call method, additional aspects of the task can be configured, for example, by calling the setProcessors method.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	call() Performs this compilation task.
void	setLocale(java.util.Locale locale) Set the locale to be applied when formatting diagnostics and other localized data.
void	setProcessors(java.lang.Iterable<? extends Processor> processors) Sets processors (for annotation processing).

Method Detail

setProcessors

void setProcessors(java.lang.Iterable<? extends Processor> processors)

Sets processors (for annotation processing). This will bypass the normal discovery mechanism.

Parameters:

processors - processors (for annotation processing)

Throws:

java.lang.IllegalStateException - if the task has started

setLocale

void setLocale(java.util.Locale locale)

Set the locale to be applied when formatting diagnostics and other localized data.

Parameters:

locale - the locale to apply; null means apply no locale

Throws:

java.lang.IllegalStateException - if the task has started

call

java.lang.Boolean call()

Performs this compilation task. The compilation may only be performed once. Subsequent calls to this method throw IllegalStateException.

Specified by:

call in interface java.util.concurrent.Callable<java.lang.Boolean>

Returns:

true if and only all the files compiled without errors; false otherwise

Throws:

java.lang.RuntimeException - if an unrecoverable error occurred in a user-supplied component. The cause will be the error in user code.

java.lang.IllegalStateException - if called more than once