Spec-Zone.ru › OpenJDK 25

Класс SimpleFormatter

java.lang.Object
java.util.logging.Formatter
java.util.logging.SimpleFormatter
public class SimpleFormatter extends Formatter
Выводит краткое описание LogRecord в удобочитаемом формате. Обычно описание занимает 1 или 2 строки.

Конфигурация: SimpleFormatter инициализируется строкой формата, указанной в свойстве java.util.logging.SimpleFormatter.format, для форматирования сообщений журнала. Это свойство можно задать в файле конфигурации свойств ведения журнала или как системное свойство. Если это свойство задано и в свойствах ведения журнала, и в системных свойствах, будет использоваться строка формата, указанная в системном свойстве. Если это свойство не задано или указанная строка формата недопустима, формат по умолчанию зависит от реализации.

Начиная с версии:
1.4
См. также:
  • Formatter

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

Конструктор Описание
SimpleFormatter()
Создает SimpleFormatter.

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

Модификатор и тип Метод Описание
String format(LogRecord record)
Форматирует указанный LogRecord.

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

formatMessage, getHead, getTail

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

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

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

SimpleFormatter

public SimpleFormatter()
Создает SimpleFormatter.

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

format

public String format(LogRecord record)
Форматирует указанный LogRecord.

Форматирование можно настроить, указав строку формата в свойстве java.util.logging.SimpleFormatter.format. Указанный LogRecord будет форматироваться так, как если бы был выполнен вызов:

   String.format(format, date, source, logger, level, message, thrown);
где аргументы следующие:
  1. format — строка формата java.util.Formatter, указанная в свойстве java.util.logging.SimpleFormatter.format, либо формат по умолчанию.
  2. date — объект ZonedDateTime, представляющий время события записи журнала в системном часовом поясе ZoneId.systemDefault().
  3. source — строка, представляющая вызывающий код, если он доступен; в противном случае — имя регистратора.
  4. logger — имя регистратора.
  5. level — уровень ведения журнала.
  6. message — отформатированное сообщение журнала, возвращаемое методом Formatter.formatMessage(LogRecord). При форматировании используется java.text, а аргумент java.util.Formatter format не используется.
  7. thrown — строка, представляющая исключение, связанное с записью журнала, и его трассировку стека, начинающуюся с символа новой строки, если они имеются; в противном случае — пустая строка.

Примеры форматов:

  • java.util.logging.SimpleFormatter.format="%4$s: %5$s [%1$tc]%n"

    Выводит одну строку с уровнем ведения журнала (4$), сообщением журнала (5$) и временной меткой (1$) в квадратных скобках.

        WARNING: warning message [Tue Mar 22 13:11:31 PDT 2011]
        
  • java.util.logging.SimpleFormatter.format="%1$tc %2$s%n%4$s: %5$s%6$s%n"

    Выводит две строки: первая содержит временную метку (1$) и источник (2$); вторая — уровень ведения журнала (4$) и сообщение журнала (5$), за которыми следуют исключение и его трассировка стека (6$), если они имеются:

        Tue Mar 22 13:11:31 PDT 2011 MyClass fatal
        SEVERE: several message with an exception
        java.lang.IllegalArgumentException: invalid argument
                at MyClass.mash(MyClass.java:9)
                at MyClass.crunch(MyClass.java:6)
                at MyClass.main(MyClass.java:3)
        
  • java.util.logging.SimpleFormatter.format="%1$tb %1$td, %1$tY %1$tl:%1$tM:%1$tS %1$Tp %2$s%n%4$s: %5$s%n"

    Выводит две строки, аналогичные примеру выше, но с другим форматом даты и времени; исключение и его трассировка стека не выводятся:

        Mar 22, 2011 1:11:31 PM MyClass fatal
        SEVERE: several message with an exception
        
  • java.util.logging.SimpleFormatter.format="%1$tb %1$td, %1$tY %1$tl:%1$tM:%1$tS.%1$tN %1$Tp %2$s%n%4$s: %5$s%6$s%n"

    Начиная с JDK 9, java.util.logging использует java.time, чтобы создавать более точные временные метки. Чтобы при указанном выше формате дополнительно выводились наносекунды, можно добавить .%1$tN к формату даты и времени:

        Feb 06, 2015 5:33:10.279216000 PM example.Main main
        INFO: This is a test
        

Этот метод также можно переопределить в подклассе. Для локализации и форматирования поля сообщения рекомендуется использовать вспомогательный метод Formatter.formatMessage(LogRecord).

Определен в:
format в классе Formatter
Параметры:
record — запись журнала для форматирования.
Возвращает:
отформатированную запись журнала

Сообщить об ошибке или предложить улучшение
Дополнительные сведения об API и документацию для разработчиков см. в разделе документации Java SE, содержащем более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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/SimpleFormatter.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API