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

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