Класс Formatter

java.lang.Object

java.util.logging.Formatter

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

public abstract class Formatter extends Object

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

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

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

Начиная с:: 1.4

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

Formatter()

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

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

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

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

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

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

Formatter

protected Formatter()

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

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

format

public abstract String format(LogRecord record)

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

Полученная форматированная строка обычно содержит локализованную и отформатированную версию поля сообщения LogRecord. Для локализации и форматирования поля сообщения рекомендуется использовать вспомогательный метод formatMessage(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.

Если параметры отсутствуют, форматирование не выполняется.
В противном случае, если строка содержит "{<digit>", где <digit> — символ из диапазона [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://docs.oracle.com/en/java/javase/25/docs/api/java.logging/java/util/logging/Formatter.html