- すべてのスーパー・インタフェース:
OptionChecker
,Tool
public interface DocumentationTool extends Tool, OptionChecker
プログラムからJavaプログラミング言語ドキュメント・ツールを起動するインタフェースです。
- 導入されたバージョン:
- 1.8
-
ネストされたクラスのサマリー
ネストされたクラス修飾子と型インタフェース説明static interface
ドキュメント・タスクのフューチャを表すインタフェースです。static class
DocumentationTool
に固有の場所です。 -
メソッドのサマリー
修飾子と型メソッド説明getStandardFileManager(DiagnosticListener<? super JavaFileObject> diagnosticListener, Locale locale, Charset charset)
このツールの標準ファイル・マネージャ実装の新しいインスタンスを返します。getTask(Writer out, JavaFileManager fileManager, DiagnosticListener<? super JavaFileObject> diagnosticListener, Class<?> docletClass, Iterable<String> options, Iterable<? extends JavaFileObject> compilationUnits)
指定のコンポーネントおよび引数を持つドキュメント・タスクのフューチャを作成します。インタフェース javax.tools.OptionCheckerで宣言されたメソッド
isSupportedOption
インタフェース javax.tools.Toolで宣言されたメソッド
getSourceVersions, name, run
-
メソッドの詳細
-
getTask
DocumentationTool.DocumentationTask getTask(Writer out, JavaFileManager fileManager, DiagnosticListener<? super JavaFileObject> diagnosticListener, Class<?> docletClass, Iterable<String> options, Iterable<? extends JavaFileObject> compilationUnits)指定のコンポーネントおよび引数を持つドキュメント・タスクのフューチャを作成します。 タスクは、DocumentationTaskインタフェースに記述されているとおりに完了していない可能性があります。ファイル・マネージャが指定されている場合、
DocumentationTool.Location
の他、StandardLocation.SOURCE_PATH
、StandardLocation.CLASS_PATH
およびStandardLocation.PLATFORM_CLASS_PATH
に定義されているすべての場所を処理できる必要があります。- パラメータ:
out
- ツールからの追加出力に使用するWriter。null
の場合はSystem.err
を使用fileManager
- ファイル・マネージャ。null
でツール標準ファイル・マネージャを使用する場合diagnosticListener
- 診断リスナー。null
の場合、ツールのデフォルトのメソッドを使用して診断情報を報告docletClass
- ドックレットに必要なメソッドを提供するクラス。null
の値は、標準ドックレットを使用することを意味します。options
- ドキュメント・ツール・オプションおよびドックレット・オプション。null
の場合、オプションは存在しないcompilationUnits
- コンパイル対象のコンパイル・ユニット。null
の場合、コンパイル・ユニットは存在しない- 戻り値:
- コンパイルを表すオブジェクト
- 例外:
RuntimeException
- ユーザー指定のコンポーネントで回復不可能なエラーが発生した場合。 causeはユーザー・コード内のエラー。IllegalArgumentException
- ソースとは別の種類のコンパイル・ユニットが指定された場合
-
getStandardFileManager
StandardJavaFileManager getStandardFileManager(DiagnosticListener<? super JavaFileObject> diagnosticListener, Locale locale, Charset charset)このツールの標準ファイル・マネージャ実装の新しいインスタンスを返します。 ファイル・マネージャは、致命的ではない診断情報の生成に、指定の診断リスナーを使用します。 致命的エラーが発生した場合、適切な例外によって通知されます。標準ファイル・マネージャは、
flush
またはclose
の呼出しのあとでアクセスされると、自動的に再起動します。 標準ファイル・マネージャは、その他のツールから利用できなければいけません。- パラメータ:
diagnosticListener
- 致命的でない診断情報用の診断リスナー。null
の場合、コンパイラのデフォルトのメソッドを使って診断情報を報告locale
- 診断情報のフォーマット時に適用されるロケール。null
の場合、デフォルトのロケールが適用される。charset
- バイトのデコードに使用された文字セット。null
の場合、プラットフォームのデフォルトの文字セットを使用- 戻り値:
- 標準ファイル・マネージャ
-