Spec-Zone.ru › OpenJDK 21

Интерфейс диагностики<S>

Параметры типа:
S - тип объекта источника, используемого этой диагностикой
public interface Diagnostic<S>
Интерфейс для диагностики из инструментов. Диагностика обычно сообщает о проблеме в определённой позиции в файле источника. Однако не все диагностики связаны с позицией или файлом.

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

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

С:
1.6

Краткое описание вложенных классов

Модификатор и тип Интерфейс Описание
static enum  Diagnostic.Kind
Типы диагностики, например, ошибка или предупреждение.

Краткое описание полей

Модификатор и тип Поле Описание
static final 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()
Возвращает смещение символов от начала объекта источника, связанного с этой диагностикой, указывающее расположение проблемы. Кроме того, должны выполняться следующие условия:

getStartPosition() <= 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
Возвращает:
локализованное сообщение

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.compiler/javax/tools/Diagnostic.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API