org.yarnandtail.andhow.util

Class AndHowLogFormatter

java.lang.Object

java.util.logging.Formatter

org.yarnandtail.andhow.util.AndHowLogFormatter

public class AndHowLogFormatter
extends Formatter

Author:

ericeverman

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANSI_RED
static String	ANSI_RESET

Constructor Summary

Constructors

Constructor and Description
AndHowLogFormatter()

Method Summary

Modifier and Type	Method and Description
String	format(LogRecord record) Format the given LogRecord.

Methods inherited from class java.util.logging.Formatter

formatMessage, getHead, getTail

Methods inherited from class java.lang.Object

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

Field Detail

ANSI_RESET

public static final String ANSI_RESET

See Also:

Constant Field Values

ANSI_RED

public static final String ANSI_RED

See Also:

Constant Field Values

Constructor Detail

AndHowLogFormatter

public AndHowLogFormatter()

Method Detail

format

public String format(LogRecord record)

Format the given LogRecord.

The formatting can be customized by specifying the severeFormat string in the java.util.logging.SimpleFormatter.severeFormat property. The given LogRecord will be formatted as if by calling:

    String.severeFormat(severeFormat, date, source, logger, level, message, thrown);
 

where the arguments are:

1. severeFormat - the java.util.Formatter severeFormat string specified in the java.util.logging.SimpleFormatter.severeFormat property or the default severeFormat.
2. date - a Date object representing event time of the log record.
3. source - a string representing the caller, if available; otherwise, the logger's name.
4. logger - the logger's name.
5. level - the log level.
6. message - the formatted log message returned from the Formatter.formatMessage(LogRecord) method. It uses java.text formatting and does not use the java.util.Formatter severeFormat argument.
7. thrown - a string representing the throwable associated with the log record and its backtrace beginning with a newline character, if any; otherwise, an empty string.

Some example formats:

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

  This prints 1 line with the log level (4$), the log message (5$) and the timestamp (1$) in a square bracket.

       WARNING: warning message [Tue Mar 22 13:11:31 PDT 2011]
       

• java.util.logging.SimpleFormatter.severeFormat="%1$tc %2$s%n%4$s: %5$s%6$s%n"

  This prints 2 lines where the first line includes the timestamp (1$) and the source (2$); the second line includes the log level (4$) and the log message (5$) followed with the throwable and its backtrace (6$), if any:

       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.severeFormat="%1$tb %1$td, %1$tY %1$tl:%1$tM:%1$tS %1$Tp %2$s%n%4$s: %5$s%n"

  This prints 2 lines similar to the example above with a different date/time formatting and does not print the throwable and its backtrace:

       Mar 22, 2011 1:11:31 PM MyClass fatal
       SEVERE: several message with an exception
       

This method can also be overridden in a subclass. It is recommended to use the Formatter.formatMessage(java.util.logging.LogRecord) convenience method to localize and severeFormat the message field.

Specified by:

format in class Formatter

Parameters:

record - the log record to be formatted.

Returns:

a formatted log record