Интерфейс Diagnostic<S>

public interface Diagnostic<S>

Интерфейс для диагностики инструментов. Диагностика обычно сообщает о проблеме в определённой позиции файла-источника. Однако не все диагностические средства связаны с позицией или файлом.

Позиция — это смещение символов, отсчитываемое от начала файла, с нуля. Отрицательные значения (кроме NOPOS) не являются допустимыми позициями.

Номера строк и столбцов начинаются с 1. Отрицательные значения (кроме NOPOS) и 0 не являются допустимыми номерами строк или столбцов.

Поля

NOPOS

static final long NOPOS

Используется для сигнализации об отсутствии позиции.

См. также:

Значения постоянных полей

Методы

getKind

Diagnostic.Kind getKind()

Возвращает вид этой диагностики, например, ошибка или предупреждение.

Возвращает:

вид этой диагностики

getSource

S getSource()

Возвращает объект источника, связанный с этой диагностикой.

Возвращает:

объект источника, связанный с этой диагностикой. null если с диагностикой не связан ни один объект источника.

getPosition

long getPosition()

Возвращает:

смещение символов от начала источника; NOPOS, если getSource() вернет null или если подходящее местоположение отсутствует

getStartPosition

long getStartPosition()

Возвращает смещение символов от начала файла, связанного с этой диагностикой, указывающее начало проблемы.

Возвращает:

смещение от начала файла; NOPOS, если и только если getPosition() возвращает NOPOS

getEndPosition

long getEndPosition()

Возвращает смещение символов от начала файла, связанного с этой диагностикой, указывающее конец проблемы.

Возвращает:

смещение от начала файла; NOPOS, если и только если getPosition() возвращает NOPOS

getLineNumber

long getLineNumber()

Возвращает номер строки смещения символов, возвращаемого методом getPosition().

Возвращает:

номер строки или NOPOS, если и только если getPosition() возвращает NOPOS

getColumnNumber

long getColumnNumber()

Возвращает номер столбца смещения символов, возвращаемого методом getPosition().

Возвращает:

номер столбца или NOPOS, если и только если getPosition() возвращает NOPOS

getCode

String getCode()

Возвращает код диагностики, указывающий на тип диагностического сообщения. Код зависит от реализации и может быть null.

Возвращает:

код диагностики

getMessage

String getMessage(Locale locale)

Возвращает локализованное сообщение для заданной локали. Фактическое сообщение зависит от реализации. Если локали null используется локаль по умолчанию.

Параметры:

locale - локаль; может быть null

Возвращает:

локализованное сообщение