Класс 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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, является ли другой объект «равным» этому объекту.
`protected void`	`finalize()`	Устарело, подлежит удалению: этот элемент API может быть удален в будущей версии. Финализация устарела и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает значение хеш-кода для этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ждать, пока он не будет разбужен, обычно посредством уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ждать, пока он не будет разбужен, обычно посредством уведомления или прерывания, либо пока не истечет заданный промежуток реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ждать, пока он не будет разбужен, обычно посредством уведомления или прерывания, либо пока не истечет заданный промежуток реального времени.

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

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.