compact3

javax.tools

インタフェースDocumentationTool

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

OptionChecker, Tool

public interface DocumentationTool
extends Tool, OptionChecker

プログラムからJava(tm)プログラミング言語ドキュメント・ツールを呼び出すインタフェースです。

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	インタフェースと説明
static interface	DocumentationTool.DocumentationTask ドキュメント・タスクのフューチャを表すインタフェースです。
static class	DocumentationTool.Location DocumentationToolに固有の場所です。

メソッドのサマリー

修飾子と型	メソッドと説明
StandardJavaFileManager	getStandardFileManager(DiagnosticListener<? super JavaFileObject> diagnosticListener, Locale locale, Charset charset) このツールの標準ファイル・マネージャ実装の新しいインスタンスを取得します。
DocumentationTool.DocumentationTask	getTask(Writer out, JavaFileManager fileManager, DiagnosticListener<? super JavaFileObject> diagnosticListener, Class<?> docletClass, Iterable<String> options, Iterable<? extends JavaFileObject> compilationUnits) 指定のコンポーネントおよび引数を持つドキュメント・タスクのフューチャを作成します。

インタフェース javax.tools.Toolから継承されたメソッド

getSourceVersions, run

インタフェース javax.tools.OptionCheckerから継承されたメソッド

isSupportedOption

メソッドの詳細

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 - ドックレットに必要なメソッドを提供するクラス

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の場合、プラットフォームのデフォルトの文字セットを使用

戻り値:

標準ファイル・マネージャ