モジュール jdk.compiler

パッケージ com.sun.source.util

インタフェースPlugin

public interface Plugin

javacプラグインのインタフェースです。

javacプラグインのメカニズムを使用すると、ユーザーはjavacコマンド行で、コンパイルの開始直後に起動される1つ以上のプラグインを指定できます。 プラグインは、ユーザーフレンドリな名前で識別されます。 起動される各プラグインは、そのプラグインに目的のオプションやその他の引数の値を指定する際に使用できる文字列の配列に渡されます。

プラグインは、注釈プロセッサと同じクラス・パス(つまり、ANNOTATION_PROCESSOR_PATHまたは-processorpath)を使用するServiceLoader経由で配置されます。

一般的なプラグインは、単に、コンパイルの実行時にイベントが通知されるTaskListenerを登録するだけで、残りの作業はタスク・リスナーで実行されると想定されています。

導入されたバージョン:

1.8

メソッドのサマリー

修飾子と型	メソッド	説明
default boolean	autoStart()	コマンド行オプションで明示的に指定されていない場合でも、このプラグインを自動的に起動するかどうかを返します。
String	getName()	このプラグインのわかりやすい名前を返します。
void	init(JavacTask task, String... args)	特定のコンパイル・タスクのプラグインを初期化します。

メソッドの詳細

getName

String getName()

このプラグインのわかりやすい名前を返します。

戻り値:

プラグインのユーザーフレンドリな名前

init

void init(JavacTask task, String... args)

特定のコンパイル・タスクのプラグインを初期化します。

パラメータ:

task - 起動されたコンパイル・タスク

args - プラグインの引数(存在する場合)

autoStart

default boolean autoStart()

コマンド行オプションで明示的に指定されていない場合でも、このプラグインを自動的に起動するかどうかを返します。

このメソッドは、サービス・ローダーが検索したすべてのプラグインに対してjavacによって呼び出されます。 このメソッドがtrueを返す場合、プラグインは明示的なコマンド行オプションによってそれ以外の方法で初期化されていないかぎり、空の文字列引数の配列を使用してinitializedになります。

戻り値:

このプラグインを自動的に起動するかどうか