Spec-Zone.ru › OpenJDK 17

Класс SimpleFormatter

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

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

С момента:
1.4
См. также:
  • Formatter

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

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

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

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

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

formatMessage, getHead, getTail

Методы, объявленные в классе java.lang.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"

    Выводит 1 строку с уровнем журнала (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"

    Выводит 2 строки, где первая строка включает отметку времени (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"

    Выводит 2 строки аналогично предыдущему примеру с другим форматированием даты/времени и без вывода исключения и его трассировки:

         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(java.util.logging.LogRecord) для локализации и форматирования поля сообщения.

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

© 1993, 2021, 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/17/docs/api/java.logging/java/util/logging/SimpleFormatter.html

Spec-Zone.ru

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