java.util.logging

Class Formatter

Contents
  • Direct Known Subclasses:
    SimpleFormatter, XMLFormatter

    public abstract class Formatter
extends Object
    A Formatter provides support for formatting LogRecords.

    Typically each logging Handler will have a Formatter associated with it. The Formatter takes a LogRecord and converts it to a string.

    Some formatters (such as the XMLFormatter) need to wrap head and tail strings around a set of formatted records. The getHeader and getTail methods can be used to obtain these strings.

    Since:
    1.4

    • Constructor Detail

      • Formatter

        protected Formatter()
        Construct a new formatter.

    • Method Detail

      • format

        public abstract String format(LogRecord record)
        Format the given log record and return the formatted string.

        The resulting formatted String will normally include a localized and formatted version of the LogRecord's message field. It is recommended to use the formatMessage(java.util.logging.LogRecord) convenience method to localize and format the message field.

        Parameters:
        record - the log record to be formatted.
        Returns:
        the formatted log record

      • getHead

        public String getHead(Handler h)
        Return the header string for a set of formatted records.

        This base class returns an empty string, but this may be overridden by subclasses.

        Parameters:
        h - The target handler (can be null)
        Returns:
        header string

      • getTail

        public String getTail(Handler h)
        Return the tail string for a set of formatted records.

        This base class returns an empty string, but this may be overridden by subclasses.

        Parameters:
        h - The target handler (can be null)
        Returns:
        tail string

      • formatMessage

        public String formatMessage(LogRecord record)
        Localize and format the message string from a log record. This method is provided as a convenience for Formatter subclasses to use when they are performing formatting.

        The message string is first localized to a format string using the record's ResourceBundle. (If there is no ResourceBundle, or if the message key is not found, then the key is used as the format string.) The format String uses java.text style formatting.

        • If there are no parameters, no formatter is used.
        • Otherwise, if the string contains "{0" then java.text.MessageFormat is used to format the string.
        • Otherwise no formatting is performed.

        Parameters:
        record - the log record containing the raw message
        Returns:
        a localized and formatted message

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/util/logging/formatter.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut