- 型パラメータ:
S
- この診断情報で使用されるソース・オブジェクトの型
public interface Diagnostic<S>
ツールからの診断情報を表示するインタフェースです。 診断情報は、通常、ソース・ファイル内の特定の位置の問題を報告します。 ただし、すべての診断情報が特定の位置やファイルに関連付けられているわけではありません。
位置は、ファイルの先頭のゼロから始まる文字オフセットです。 負の値(NOPOS
を除く)は有効な位置ではありません。
行番号と列番号は1から始まります。 負の値(NOPOS
を除く)とゼロは有効な行番号または列番号ではありません。
- 導入されたバージョン:
- 1.6
-
ネストされたクラスのサマリー
-
フィールドのサマリー
-
メソッドのサマリー
修飾子と型メソッド説明getCode()
診断の型を示す診断コードを返します。long
getPosition()が返す文字オフセットの列番号を返します。long
この診断に関連するファイルの先頭から、問題の終了を示す文字オフセットを返します。getKind()
この診断の種類(エラーまたは警告など)を返します。long
getPosition()が返す文字オフセットの行番号を返します。getMessage
(Locale locale) 指定されたロケールのローカライズされたメッセージを返します。long
この診断に関連付けられたソース・オブジェクトの先頭から、問題のロケーションを示す文字オフセットを返します。この診断に関連付けられたソース・オブジェクトを返します。long
この診断に関連するファイルの先頭から、問題の開始を示す文字オフセットを返します。
-
フィールド詳細
-
NOPOS
static final long NOPOS位置にアクセスできないことを通知するために使用されます。- 関連項目:
-
-
メソッドの詳細
-
getKind
Diagnostic.Kind getKind()この診断の種類(エラーまたは警告など)を返します。- 戻り値:
- この診断情報の種類
-
getSource
S getSource()この診断に関連付けられたソース・オブジェクトを返します。- 戻り値:
- この診断情報に関連したソース・オブジェクト。この診断情報に関連したソース・オブジェクトが存在しない場合は
null
。
-
getPosition
long getPosition()この診断に関連付けられたソース・オブジェクトの先頭から、問題のロケーションを示す文字オフセットを返します。 また、次の条件が満たされている必要があります。getStartPosition() <= 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
指定されたロケールのローカライズされたメッセージを返します。 実際のメッセージは実装に依存します。 ロケールがnull
の場合、デフォルトのロケールが使用されます。- パラメータ:
locale
- ロケール。null
も可- 戻り値:
- ローカライズされたメッセージ
-