File Doc Category Size Date Package
Tool.java API Doc Java SE 6 API 1711 Tue Jun 10 00:27:02 BST 2008 javax.tools

Tool

public interface Tool

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

Tools can be located using {@link java.util.ServiceLoader#load(Class)}.

author: Neal M Gafter
author: Peter von der Ahé
author: Jonathan Gibbons
since: 1.6

Fields Summary
Constructors Summary
Methods Summary
public java.util.Set getSourceVersions()
Gets the source versions of the Java™ programming language supported by this tool.
return
a set of supported source versions
public int run(java.io.InputStream in, java.io.OutputStream out, java.io.OutputStream err, java.lang.String arguments)
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 {@code out} or {@code err} in some unspecified format.
param
in "standard" input; use System.in if null
param
out "standard" output; use System.out if null
param
err "standard" error; use System.err if null
param
arguments arguments to pass to the tool
return
0 for success; nonzero otherwise
throws
NullPointerException if the array of arguments contains any {@code null} elements.