モジュール jdk.javadoc

パッケージ jdk.javadoc.doclet

インタフェースReporter

public interface Reporter

診断およびその他のメッセージをレポートするためのインタフェース。

診断はdiagnostic kindとメッセージで構成され、さらにelement、ドキュメント・コメントのtree node、または特定のfileの任意の位置に関連付けられます。 その他のメッセージは、"標準出力"および"診断出力"で使用するために非公式に使用される2つのストリームのいずれかに直接書き込まれます。"標準出力"は、一部の演算の実行結果として期待される出力を意味します。たとえば、--helpオプションを使用するときに生成されるコマンド行ヘルプや、"診断出力"は、演算の実行の副作用であるエラー、警告、その他の出力を指します。

診断が出力される正確な方法は不特定であり、包含コンテキストによって異なります。 たとえば:

• DocumentationTool APIを使用すると、クライアントは診断がreportedになるDiagnosticListenerを指定できます。 リスナーが指定されていない場合は、診断が特定のストリームに書き込まれるか、そのようなストリームが指定されない場合はSystem.errに書き込まれます。
• ToolProvider APIを使用すると、クライアントは標準出力および診断出力のレポートに使用するストリームを指定できます。

導入されたバージョン:

9

メソッドのサマリー

修飾子と型	メソッド	説明
default PrintWriter	getDiagnosticWriter()	診断出力の書込みに使用できるライターを返します。そのようなライターを使用できない場合はnullを返します。
default PrintWriter	getStandardWriter()	診断以外の出力の作成に使用できるライターを返します。そのようなライターを使用できない場合はnullを返します。
default void	print(Diagnostic.Kind kind, DocTreePath path, int start, int pos, int end, String message)	ツリー・ノード内の文字範囲内の位置に関連する診断メッセージを出力します。
void	print(Diagnostic.Kind kind, DocTreePath path, String message)	ドキュメント・コメントのツリー・ノードに関連する診断メッセージを出力します。
void	print(Diagnostic.Kind kind, String message)	診断メッセージを出力します。
void	print(Diagnostic.Kind kind, Element element, String message)	エレメントに関連する診断メッセージを出力します。
default void	print(Diagnostic.Kind kind, FileObject file, int start, int pos, int end, String message)	ファイル内の文字範囲内の位置に関連する診断メッセージを出力します。

メソッドの詳細

print

void print(Diagnostic.Kind kind, String message)

診断メッセージを出力します。

パラメータ:

kind - 診断の種類

message - 印刷するメッセージ

print

void print(Diagnostic.Kind kind, DocTreePath path, String message)

ドキュメント・コメントのツリー・ノードに関連する診断メッセージを出力します。

パラメータ:

kind - 診断の種類

path - ツリー・ノードのパス

message - 印刷するメッセージ

print

default void print(Diagnostic.Kind kind, DocTreePath path, int start, int pos, int end, String message)

ツリー・ノード内の文字範囲内の位置に関連する診断メッセージを出力します。 特定のパスのリーフ・ノードとしてサポートされているのは、単純な文字列値をラップするタイプのDocTreeのみです。 現在、これにはCommentTree、DocTypeTree、ReferenceTree、およびTextTreeが含まれます。 位置はすべて、文字列の先頭から0ベースの文字オフセットになります。 位置は、関係start <= pos <= endを満たす必要があります。

実装要件:

この実装では、(start, pos, end)値を無視し、単にprint(kind, path, message)をコールします。

パラメータ:

kind - 診断の種類

path - ツリー・ノードのパス

start - 囲み範囲の開始

pos - 位置

end - 囲み範囲の終了

message - 印刷するメッセージ

例外:

IllegalArgumentException - start、posおよびendが有効な範囲を形成しない場合。

導入されたバージョン:

18

print

void print(Diagnostic.Kind kind, Element element, String message)

エレメントに関連する診断メッセージを出力します。

パラメータ:

kind - 診断の種類

element - 要素

message - 印刷するメッセージ

print

default void print(Diagnostic.Kind kind, FileObject file, int start, int pos, int end, String message)

ファイル内の文字範囲内の位置に関連する診断メッセージを出力します。 位置はすべて、ファイルのコンテンツの最初からの0ベースの文字オフセットです。 位置は、関係start <= pos <= endを満たす必要があります。

実装要件:

この実装は常にUnsupportedOperationExceptionをスローします。 javadocツールでinitializeに提供される実装によって、この実装が上書きされます。

パラメータ:

kind - 診断の種類

file - ファイル

start - 囲み範囲の開始

pos - 位置

end - 囲み範囲の終了

message - 印刷するメッセージ

導入されたバージョン:

17

getStandardWriter

default PrintWriter getStandardWriter()

診断以外の出力の作成に使用できるライターを返します。そのようなライターを使用できない場合はnullを返します。

APIのノート:

値は、getDiagnosticWriter()によって返される値と同じ場合と異なる場合があります。

実装要件:

この実装ではnullが返されます。 javadocツールによってinitializeに提供される実装では、常にnull以外の値が返されます。

戻り値:

ライター

導入されたバージョン:

17

getDiagnosticWriter

default PrintWriter getDiagnosticWriter()

診断出力の書込みに使用できるライターを返します。そのようなライターを使用できない場合はnullを返します。

APIのノート:

値は、getStandardWriter()によって返される値と同じ場合と異なる場合があります。

実装要件:

この実装ではnullが返されます。 javadocツールによってinitializeに提供される実装では、常にnull以外の値が返されます。

戻り値:

ライター

導入されたバージョン:

17