Tool (Java Platform SE 6)

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.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.tools
interface Tool

Most common way to construct:

Tool compiler = ToolProvider.getSystemJavaCompiler();

Based on 6 examples

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)}.

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

Method Detail

getSourceVersions

public Set getSourceVersions()

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

Returns:: a set of supported source versions

run

public int run(InputStream in,
               OutputStream out,
               OutputStream err,
               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.

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 - arguments to pass to the tool
Returns:: 0 for success; nonzero otherwise