モジュール java.compiler

パッケージ javax.tools

インタフェース・ツール

既知のすべてのサブインタフェース:

DocumentationTool, JavaCompiler

public interface Tool

プログラムから呼出し可能なツールの共通インタフェースです。 ツールは従来、コンパイラのようなコマンド行プログラムです。 プラットフォームで使用可能なツール・セットは、ベンダーで定義されています。

ツールの検索は、ServiceLoader.load(Class)を使って実行できます。

導入されたバージョン:

1.6

メソッドのサマリー

修飾子と型	メソッド	説明
Set<SourceVersion>	getSourceVersions()	このツールでサポートされているJava™プログラミング言語のソース・バージョンを返します。
default String	name()	このツールの名前を返します。名前が指定されていない場合は空の文字列を返します。
int	run(InputStream in, OutputStream out, OutputStream err, String... arguments)	入出力チャネルと引数を指定して、ツールを実行します。

メソッドの詳細

name

default String name()

このツールの名前を返します。名前が指定されていない場合は空の文字列を返します。

APIに関するノート:

コマンドラインで使用される名前と同じ名前を使用することをお勧めします: たとえば、"javac"、"jar"、"jlink"。

実装上のノート:

この実装は、空の文字列を返します。

戻り値:

このツールの名前

導入されたバージョン:

9

run

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

入出力チャネルと引数を指定して、ツールを実行します。 規約により、ツールは、実行に成功した場合はゼロ、エラーが発生した場合はゼロ以外を返します。 生成された診断情報はすべて、何らかの形式(未指定)でoutまたはerrに書き込まれます。

パラメータ:

in - 標準入力。nullの場合はSystem.inを使用

out - 標準出力。nullの場合はSystem.outを使用

err - 標準エラー。nullの場合はSystem.errを使用

arguments - ツールに渡される引数

戻り値:

成功の場合はゼロ、そうでない場合はゼロ以外

例外:

NullPointerException - 引数の配列にnull要素が含まれている場合。

getSourceVersions

Set<SourceVersion> getSourceVersions()

このツールでサポートされているJava™プログラミング言語のソース・バージョンを返します。

戻り値:

サポートされているソース・バージョンのセット