Класс Formatter

java.lang.Object

java.util.logging.Formatter

Прямые известные подклассы:: SimpleFormatter, XMLFormatter

public abstract class Formatter extends Object

Класс Formatter предоставляет поддержку форматирования записей журнала.

Обычно каждый обработчик журналов имеет связанный с ним класс Formatter. Класс Formatter принимает запись журнала и преобразует её в строку.

Некоторые форматировщики (например, XMLFormatter) должны оборачивать начальную и конечную строки вокруг набора отформатированных записей. Методы getHeader и getTail могут использоваться для получения этих строк.

С:: 1.4

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

Formatter()

Модификатор	Конструктор	Описание
`protected`	Создаёт новый форматировщик.

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

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

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

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

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

Formatter

protected Formatter()

Создаёт новый форматировщик.

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

format

public abstract String format(LogRecord record)

Форматирует заданную запись журнала и возвращает отформатированную строку.

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

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

getHead

public String getHead(Handler h)

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

Этот базовый класс возвращает пустую строку, но это может быть переопределено подклассами.

Параметры:: h - целевой обработчик (может быть null)
Возвращает:: заголовок

getTail

public String getTail(Handler h)

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

Этот базовый класс возвращает пустую строку, но это может быть переопределено подклассами.

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

formatMessage

public String formatMessage(LogRecord record)

Локализует и форматирует строку сообщения из записи журнала. Этот метод предоставляется в качестве удобства для подклассов Formatter, которые выполняют форматирование.

Сначала строка сообщения локализуется в строку формата с помощью ResourceBundle записи. (Если ResourceBundle отсутствует или ключ сообщения не найден, то ключ используется в качестве строки формата.) Строка формата использует форматирование в стиле java.text.

Если нет параметров, форматирование не используется.
В противном случае, если строка содержит "{<цифра>}" где <цифра> в диапазоне [0-9], используется java.text.MessageFormat для форматирования строки.
В противном случае форматирование не выполняется.

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

© 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/java.logging/java/util/logging/Formatter.html