java.util.logging

Class Formatter

Known Direct Subclasses:
Simple1LineFormatter, SimpleFormatter, XMLFormatter

public abstract class Formatter
extends Object

A Formatter supports handlers by localizing message texts and by subsituting parameter values for their placeholders.

Constructor Summary

Formatter()
Constructs a new Formatter.

Method Summary

abstract String
format(LogRecord record)
Formats a LogRecord into a string.
String
formatMessage(LogRecord record)
Formats the message part of a log record.
String
getHead(Handler handler)
Returns a string that handlers are supposed to emit before the first log record.
String
getTail(Handler handler)
Returns a string that handlers are supposed to emit after the last log record.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Formatter

protected Formatter()
Constructs a new Formatter.

Method Details

format

public abstract String format(LogRecord record)
Formats a LogRecord into a string. Usually called by handlers which need a string for a log record, for example to append a record to a log file or to transmit a record over the network.
Parameters:
record - the log record for which a string form is requested.

formatMessage

public String formatMessage(LogRecord record)
Formats the message part of a log record.

First, the Formatter localizes the record message to the default locale by looking up the message in the record's localization resource bundle. If this step fails because there is no resource bundle associated with the record, or because the record message is not a key in the bundle, the raw message is used instead.

Second, the Formatter substitutes appropriate strings for the message parameters. If the record returns a non-empty array for getParameters() and the localized message string contains the character sequence "{0", the formatter uses java.text.MessageFormat to format the message. Otherwise, no parameter substitution is performed.

Parameters:
record - the log record to be localized and formatted.
Returns:
the localized message text where parameters have been substituted by suitable strings.
Throws:
NullPointerException - if record is null.

getHead

public String getHead(Handler handler)
Returns a string that handlers are supposed to emit before the first log record. The base implementation returns an empty string, but subclasses such as XMLFormatter override this method in order to provide a suitable header.
Parameters:
handler - the handler which will prepend the returned string in front of the first log record. This method may inspect certain properties of the handler, for example its encoding, in order to construct the header.
Returns:
a string for the header.

getTail

public String getTail(Handler handler)
Returns a string that handlers are supposed to emit after the last log record. The base implementation returns an empty string, but subclasses such as XMLFormatter override this method in order to provide a suitable tail.
Parameters:
handler - the handler which will append the returned string after the last log record. This method may inspect certain properties of the handler in order to construct the tail.
Returns:
a string for the header.

Formatter.java -- A class for formatting log messages by localizing message texts and performing substitution of parameters Copyright (C) 2002, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.