Класс XMLFormatter

java.lang.Object

java.util.logging.Formatter

java.util.logging.XMLFormatter

public class XMLFormatter extends Formatter

Форматирует запись LogRecord в стандартном формате XML.

Спецификация DTD приведена в Приложении A к спецификации Java Logging APIs.

XMLFormatter можно использовать с произвольными кодировками символов, но рекомендуется использовать UTF-8. Кодировку символов можно установить в обработчике вывода.

Требования к реализации:

С JDK 9 экземпляры LogRecord содержат Instant, который может содержать наносекунды ниже миллисекундного разрешения. Спецификация DTD была обновлена, чтобы разрешить необязательный элемент <nanos>. По умолчанию XMLFormatter вычислит корректировку наносекунд ниже миллисекундного разрешения (используя LogRecord.getInstant().getNano() % 1000_000) - и если она не равна 0, это значение корректировки будет выведено в новый элемент <nanos>. Время события можно восстановить, используя Instant.ofEpochSecond(millis/1000L, (millis % 1000L) * 1000_000L + nanos), где millis и nanos представляют числа, сериализованные в элементах <millis> и <nanos> соответственно.
Элемент <date> теперь будет содержать все время события, отформатированное с помощью DateTimeFormatter.ISO_INSTANT форматировщика.

Для совместимости со старыми парсерами, XMLFormatters можно настроить на возвращение к старому формату, указав <xml-formatter-fully-qualified-class-name>.useInstant = false свойство в настройках ведения журнала. Когда useInstant равно false, сохранится старый формат. Когда useInstant равно true (по умолчанию), элемент <nanos> будет напечатан, а элемент <date> будет содержать отформатированное время события.

Например, для настройки обычных экземпляров XMLFormatter на пропускание нового элемента <nano>, можно указать java.util.logging.XMLFormatter.useInstant = false в настройках ведения журнала.

С:

1.4

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

Конструктор	Описание
`XMLFormatter()`	Создает новый экземпляр XMLFormatter.

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

Модификатор и тип	Метод	Описание
`String`	`format(LogRecord record)`	Форматирует заданное сообщение в XML.
`String`	`getHead(Handler h)`	Возвращает строку заголовка для набора записей, отформатированных в XML.
`String`	`getTail(Handler h)`	Возвращает строку хвоста для набора записей, отформатированных в XML.

Методы, объявленные в классе java.util.logging.Formatter

formatMessage

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

XMLFormatter

public XMLFormatter()

Создает новый экземпляр XMLFormatter.

Требования к реализации:: С JDK 9 XMLFormatter будет выводить время события записи события в виде момента времени. Этот момент имеет наилучшее доступное на системе разрешение. Элемент <date> будет содержать мгновение, отформатированное с помощью DateTimeFormatter.ISO_INSTANT. Кроме того, будет напечатан необязательный элемент <nanos>, содержащий корректировку наносекунд, если момент времени содержит наносекунды ниже миллисекундного разрешения.
Это новое поведение можно отключить и восстановить старый формат, указав свойство в настройках ведения журнала. Если LogManager.getLogManager().getProperty( this.getClass().getName()+".useInstant") равно "false" или "0", старый формат будет восстановлен.

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

format

public String format(LogRecord record)

Форматирует заданное сообщение в XML.

Этот метод можно переопределить в подклассе. Рекомендуется использовать удобный метод Formatter.formatMessage(java.util.logging.LogRecord) для локализации и форматирования поля сообщения.

Определено в:: format в классе Formatter
Параметры:: record - запись журнала, которую необходимо отформатировать.
Возвращает:: отформатированная запись журнала

getHead

public String getHead(Handler h)

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

Переопределяет:: getHead в классе Formatter
Параметры:: h - целевой обработчик (может быть null)
Возвращает:: действительная строка XML

getTail

public String getTail(Handler h)

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

Переопределяет:: getTail в классе Formatter
Параметры:: h - целевой обработчик (может быть null)
Возвращает:: действительная строка XML

© 1993, 2021, 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/17/docs/api/java.logging/java/util/logging/XMLFormatter.html