Интерфейс Reporter

public interface Reporter

Интерфейс для отчётности о диагностике и других сообщениях.

Диагностика состоит из diagnostic kind и сообщения и дополнительно может быть связана с element, tree node в комментарии документации или произвольной позицией в данном file. Другие сообщения могут быть записаны непосредственно в один из двух потоков, неофициально используемых для «стандартного вывода» и «вывода диагностики», где «стандартный вывод» означает вывод, который является ожидаемым результатом выполнения какой-либо операции, например, справка командной строки, которая генерируется при использовании --help опции, а «вывод диагностики» относится к любым ошибкам, предупреждениям и другому выводу, который является побочным эффектом выполнения операции.

Точный способ вывода диагностики не указан и зависит от окружающего контекста. Например:

API DocumentationTool позволяет клиенту указать DiagnosticListener, в который будет reported диагностика. Если слушатель не указан, диагностика будет выводиться в заданный поток или в System.err, если такой поток не предоставлен.
API ToolProvider позволяет клиенту указать потоки, используемые для отчётности о стандартном и диагностическом выводе.

Since:: 9

Краткое описание методов

Модификатор и тип	Метод	Описание
`default PrintWriter`	`getDiagnosticWriter()`	Возвращает объект записи, который можно использовать для записи диагностического вывода, или `null`, если такой объект записи недоступен.
`default PrintWriter`	`getStandardWriter()`	Возвращает объект записи, который можно использовать для записи вывода, не являющегося диагностическим, или `null`, если такой объект записи недоступен.
`default void`	`print(Diagnostic.Kind kind, DocTreePath path, int start, int pos, int end, String message)`	Выводит сообщение диагностики, связанное с позицией в диапазоне символов в узле дерева.
`void`	`print(Diagnostic.Kind kind, DocTreePath path, String message)`	Выводит сообщение диагностики, связанное с узлом дерева в комментарии документации.
`void`	`print(Diagnostic.Kind kind, String message)`	Выводит сообщение диагностики.
`void`	`print(Diagnostic.Kind kind, Element element, String message)`	Выводит сообщение диагностики, связанное с элементом.
`default void`	`print(Diagnostic.Kind kind, FileObject file, int start, int pos, int end, String message)`	Выводит сообщение диагностики, связанное с позицией в диапазоне символов в файле.

Подробное описание методов

print

void print(Diagnostic.Kind kind, String message)

Выводит сообщение диагностики.

Параметры:: kind - тип диагностики; message - сообщение для вывода

print

void print(Diagnostic.Kind kind, DocTreePath path, String message)

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

Параметры:: kind - тип диагностики; path - путь к узлу дерева; message - сообщение для вывода

print

default void print(Diagnostic.Kind kind, DocTreePath path, int start, int pos, int end, String message)

Выводит сообщение диагностики, связанное с позицией в диапазоне символов в узле дерева. Поддерживаются только типы DocTree, которые оборачивают простое строковое значение в качестве листовых узлов заданного пути. В настоящее время это включает в себя CommentTree, DocTypeTree, ReferenceTree и TextTree. Позиции — это смещения символов, начиная с начала строки. Позиции должны удовлетворять соотношению start <= pos <= end.

Требования к реализации:: Данная реализация игнорирует значения (start, pos, end) и просто вызывает print(kind, path, message).
Параметры:: kind - тип диагностики; path - путь к узлу дерева; start - начало содержащего диапазона; pos - позиция; end - конец содержащего диапазона; message - сообщение для вывода
Исключения:: IllegalArgumentException - если start, pos и end не образуют допустимый диапазон.
Since:: 18

print

void print(Diagnostic.Kind kind, Element element, String message)

Выводит сообщение диагностики, связанное с элементом.

Параметры:: kind - тип диагностики; element - элемент; message - сообщение для вывода

print

default void print(Diagnostic.Kind kind, FileObject file, int start, int pos, int end, String message)

Выводит сообщение диагностики, связанное с позицией в диапазоне символов в файле. Позиции — это смещения символов, начиная с начала содержимого файла. Позиции должны удовлетворять соотношению start <= pos <= end.

Требования к реализации:: Данная реализация всегда выбрасывает UnsupportedOperationException. Реализация, предоставляемая инструментом javadoc для initialize doclet, переопределяет эту реализацию.
Параметры:: kind - тип диагностики; file - файл; start - начало содержащего диапазона; pos - позиция; end - конец содержащего диапазона; message - сообщение для вывода
Since:: 17

getStandardWriter

default PrintWriter getStandardWriter()

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

Примечание API:: Значение может совпадать или не совпадать со значением, возвращаемым getDiagnosticWriter().
Требования к реализации:: Данная реализация возвращает null. Реализация, предоставляемая инструментом javadoc для initialize doclet, всегда возвращает значение, отличное от null.
Возвращает:: объект записи
Since:: 17

getDiagnosticWriter

default PrintWriter getDiagnosticWriter()

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

Примечание API:: Значение может совпадать или не совпадать со значением, возвращаемым getStandardWriter().
Требования к реализации:: Данная реализация возвращает null. Реализация, предоставляемая инструментом javadoc для initialize doclet, всегда возвращает значение, отличное от null.
Возвращает:: объект записи
Since:: 17

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/jdk.javadoc/jdk/javadoc/doclet/Reporter.html