-
- 含まれているインタフェース:
- DocumentationTool
public static interface DocumentationTool.DocumentationTask extends Callable<Boolean>
-
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 抽象メソッド 修飾子と型 メソッド 説明 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
- 複数回呼び出された場合
-
-