javax.tools

インタフェース Diagnostic<S>

型パラメータ:

S - この診断情報で使用されるソースオブジェクトの型

public interface Diagnostic<S>

ツールからの診断情報を表示するインタフェースです。診断情報は、通常、ソースファイル内の特定の位置の問題を報告します。ただし、すべての診断情報が特定の位置やファイルに関連付けられているわけではありません。

位置は、ファイルの先頭のゼロから始まる文字オフセットです。負の値 (NOPOS を除く) は有効な位置ではありません。

行番号と列番号は 1 から始まります。負の値 (NOPOS を除く) とゼロは有効な行番号または列番号ではありません。

導入されたバージョン:

1.6

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

ネストされたクラス

修飾子と型	インタフェースと説明
static class	Diagnostic.Kind 診断情報の種類 (エラー、警告など) です。

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static long	NOPOS 位置にアクセスできないことを通知するために使用されます。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String	getCode() 診断情報の種類を示す診断コードを取得します。
long	getColumnNumber() getPosition() によって返される文字オフセットの列番号を取得します。
long	getEndPosition() この診断情報に関連したファイルの先頭からの文字オフセット (問題の終了位置を示す) を取得します。
Diagnostic.Kind	getKind() この診断情報の種類 (エラー、警告など) を取得します。
long	getLineNumber() getPosition() によって返される文字オフセットの行番号を取得します。
String	getMessage(Locale locale) 指定のロケール用にローカライズされたメッセージを取得します。
long	getPosition() この診断情報に関連したソースオブジェクトの先頭からの文字オフセット (問題の位置を示す) を取得します。
S	getSource() この診断情報に関連したソースオブジェクトを取得します。
long	getStartPosition() この診断情報に関連したファイルの先頭からの文字オフセット (問題の開始位置を示す) を取得します。

フィールドの詳細

NOPOS

static final long NOPOS

位置にアクセスできないことを通知するために使用されます。

関連項目:

定数フィールド値

メソッドの詳細

getKind

Diagnostic.Kind getKind()

この診断情報の種類 (エラー、警告など) を取得します。

戻り値:

この診断情報の種類

getSource

S getSource()

この診断情報に関連したソースオブジェクトを取得します。

戻り値:

この診断情報に関連したソースオブジェクト。この診断情報に関連したソースオブジェクトが存在しない場合は null。

getPosition

long getPosition()

この診断情報に関連したソースオブジェクトの先頭からの文字オフセット (問題の位置を示す) を取得します。また、次の条件が満たされている必要があります。

getStartPostion() <= getPosition()

getPosition() <= getEndPosition()

戻り値:

ソースの先頭からの文字オフセット。getSource() が null を返す場合、または適切な位置がない場合は NOPOS

getStartPosition

long getStartPosition()

この診断情報に関連したファイルの先頭からの文字オフセット (問題の開始位置を示す) を取得します。

戻り値:

ファイルの先頭からのオフセット。getPosition() が NOPOS を返す場合にかぎり NOPOS

getEndPosition

long getEndPosition()

この診断情報に関連したファイルの先頭からの文字オフセット (問題の終了位置を示す) を取得します。

戻り値:

ファイルの先頭からのオフセット。getPosition() が NOPOS を返す場合にかぎり NOPOS

getLineNumber

long getLineNumber()

getPosition() によって返される文字オフセットの行番号を取得します。

戻り値:

行番号。getPosition() が NOPOS を返す場合に限り NOPOS

getColumnNumber

long getColumnNumber()

getPosition() によって返される文字オフセットの列番号を取得します。

戻り値:

列番号。getPosition() が NOPOS を返す場合に限り NOPOS

getCode

String getCode()

診断情報の種類を示す診断コードを取得します。このコードは実装によって異なり、null の場合もあります。

戻り値:

診断コード

getMessage

String getMessage(Locale locale)

指定のロケール用にローカライズされたメッセージを取得します。実際のメッセージは実装に依存します。ロケールが null の場合、デフォルトのロケールが使用されます。

パラメータ:

locale - ロケール。null も可

戻り値:

ローカライズされたメッセージ