compact3

javax.tools

インタフェースDocumentationTool.DocumentationTask

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

Callable<Boolean>

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

DocumentationTool

public static interface DocumentationTool.DocumentationTask
extends Callable<Boolean>

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

callメソッドを呼び出す前に、setLocaleメソッドを呼び出すなどして、タスクのその他の構成を行うことができます。

メソッドのサマリー

修飾子と型	メソッドと説明
Boolean	call() このドキュメント・タスクを実行します。
void	setLocale(Locale locale) 診断情報とその他のローカライズ済みデータのフォーマット時にロケールを適用するように設定します。

メソッドの詳細

setLocale

void setLocale(Locale locale)

診断情報とその他のローカライズ済みデータのフォーマット時にロケールを適用するように設定します。

パラメータ:

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

例外:

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

call

Boolean call()

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

定義:

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

戻り値:

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

例外:

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

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