javax.tools
Interface Tool

All Known Subinterfaces:

JavaCompiler JavaCompilerTool

public interface Tool

Common interface for tools that can be invoked from a Java program. A tool is traditionally a command line program such as a compiler. The set of tools available with on a platform is defined by the vendor.

Tools can be located using ServiceLoader.load(Class) . ToolProvider.installedTools.

Since: See Also:

1.6

ToolProvider.installedTools(java.lang.Class )

Method Summary
Set < SourceVersion	getSourceVersions ()           Gets the source versions of the Java programming language supported by this tool.
int	run ( InputStream  in, Writer  out, Writer  err, String           Run the tool with the given I/O channels and arguments.
int	run ( InputStream  in, OutputStream  out, OutputStream  err, String           Run the tool with the given I/O channels and arguments.

run

int run(InputStream in,
 OutputStreamWriter out,
 OutputStreamWriter err,
        String... arguments) ... args) 

Run the tool with the given I/O channels and arguments. By convention a tool returns 0 for success and nonzero for errors. Any diagnostics generated will be written to either one of out or err in some unspecified format.

Parameters:

in - "standard" input; use System.in if null

out - "standard" output; use System.out if null

err - "standard" error; use System.err if null

arguments args - arguments to pass to the tool

Returns:

0 for success; nonzero otherwise

Throws:

NullPointerException - if the array of arguments contains any null elements.

getSourceVersions

 
 Set< SourceVersion> getSourceVersions () 

Gets the source versions of the Java programming language supported by this tool.

Returns:

a set of supported source versions