javax.tools

Interface JavaCompiler.CompilationTask

All Superinterfaces:
Callable<V>

public static interface JavaCompiler.CompilationTask
extends Callable<V>

Interface representing a compilation task as an asynchronous event or Future. The task may be started by invoking call(). Prior to this, the task may be configured by the user using the other methods of this interface.
Since:
1.6

Method Summary

Boolean
call()
Performs the compilation.
void
setLocale(Locale locale)
Sets the locale to use for outputting diagnostics.
void
setProcessors(Processor> processors)
Explicitly set the annotation processors to be used, overriding the usual discovery process.

Methods inherited from interface java.util.concurrent.Callable<V>

call

Method Details

call

public Boolean call()
Performs the compilation. The compilation may only be performed once. Subsequent calls will throw an IllegalStateException.
Specified by:
call in interface Callable<V>
Returns:
true if all files were successfully compiled.
Throws:
RuntimeException - if an unrecoverable error occurred in a user-supplied component of the compilation process. The user exception will be provided as the cause of this exception.
IllegalStateException - if the compilation has already run.

setLocale

public void setLocale(Locale locale)
Sets the locale to use for outputting diagnostics.
Parameters:
locale - the locale to use. A value of null means no locale is applied.
Throws:
IllegalStateException - if the compilation has started.

setProcessors

public void setProcessors(Processor> processors)
Explicitly set the annotation processors to be used, overriding the usual discovery process.
Parameters:
processors - the processors to use.
Throws:
IllegalStateException - if the compilation has started.

JavaCompiler.java -- Programmatic interface for a compiler. Copyright (C) 2012 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.