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

Параметры типа:: S - тип объекта источника, используемого этим диагностическим инструментом

public interface Diagnostic<S>

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

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

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

С тех пор:: 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()

Возвращает:: смещение символов от начала источника; 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
Возвращает:: локализованное сообщение