Класс Formatter

java.lang.Object
- java.util.logging.Formatter

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

public abstract class Formatter
extends Object

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

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

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

С момента:: 1.4

Конструкторы

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

Методы

Модификатор и тип	Метод и описание
`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", используется java.text.MessageFormat для форматирования строки.
В противном случае форматирование не выполняется.

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

© 1993, 2020, 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.