モジュール java.compiler

パッケージ javax.tools

インタフェースDocumentationTool.DocumentationTask

すべてのスーパー・インタフェース:

Callable<Boolean>

含まれているインタフェース:

DocumentationTool

public static interface DocumentationTool.DocumentationTask extends Callable<Boolean>

ドキュメント・タスクのフューチャを表すインタフェースです。 タスクはまだ開始されていません。 コンパイル・タスクを開始するには、callメソッドを呼び出します。

callメソッドをコールする前に、setLocaleメソッドをコールするなどして、タスクの追加の側面を構成できます。

メソッドのサマリー

修飾子と型	メソッド	説明
void	addModules(Iterable<String> moduleNames)	モジュールの解決時に考慮されるルート・モジュールを追加します。
Boolean	call()	このドキュメント・タスクを実行します。
void	setLocale(Locale locale)	診断およびその他のローカライズされたデータの書式設定時に適用されるロケールを設定します。

メソッドの詳細

addModules

void addModules(Iterable<String> moduleNames)

モジュールの解決時に考慮されるルート・モジュールを追加します。 モジュール名が無効な場合、IllegalArgumentExceptionがスローされるか、またはタスクの開始時に診断がレポートされます。

パラメータ:

moduleNames - ルート・モジュールの名前

例外:

IllegalArgumentException - 無効なモジュール名のために投げられるかもしれない

IllegalStateException - タスクが開始されている場合

導入されたバージョン:

9

setLocale

void setLocale(Locale locale)

診断およびその他のローカライズされたデータの書式設定時に適用されるロケールを設定します。

パラメータ:

locale - 適用するロケール。nullの場合、ロケールは適用されない

例外:

IllegalStateException - タスクが開始されている場合

call

Boolean call()

このドキュメント・タスクを実行します。 タスクは一度だけ実行できます。 このメソッドへの後続のコールでは、IllegalStateExceptionがスローされます。

定義:

call、インタフェースCallable<Boolean>

戻り値:

すべてのファイルがエラーなく処理された場合にかぎりtrue。そうでない場合はfalse

例外:

RuntimeException - ユーザー指定のコンポーネントで回復不可能なエラーが発生した場合。 causeはユーザー・コード内のエラー。

IllegalStateException - 複数回呼び出された場合