This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.tools
interface JavaCompiler.CompilationTask

All Superinterfaces:
Callable

public static interface JavaCompiler.CompilationTask
extends Callable

Interface representing a future for a compilation task. The compilation task has not yet started. To start the task, call the {@linkplain #call call} method.

Before calling the call method, additional aspects of the task can be configured, for example, by calling the {@linkplain #setProcessors setProcessors} method.


Method Summary
 Boolean

          Performs this compilation task.
 void
setLocale(Locale locale)

          Set the locale to be applied when formatting diagnostics and other localized data.
 void
setProcessors(Iterable processors)

          Sets processors (for annotation processing).
 
Methods inherited from class java.util.concurrent.Callable
call
 

Method Detail

call

public Boolean call()
Performs this compilation task. The compilation may only be performed once. Subsequent calls to this method throw IllegalStateException.

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

setLocale

public void setLocale(Locale locale)
Set the locale to be applied when formatting diagnostics and other localized data.

Parameters:
locale - the locale to apply; {@code null} means apply no locale

setProcessors

public void setProcessors(Iterable processors)
Sets processors (for annotation processing). This will bypass the normal discovery mechanism.

Parameters:
processors - processors (for annotation processing)


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.