de.unkrig.commons.util.logging.formatter

Class PrintfFormatter

java.lang.Object

java.util.logging.Formatter

de.unkrig.commons.util.logging.formatter.PrintfFormatter

public class PrintfFormatter
extends Formatter

A Formatter that formats a LogRecord through a format string (as described for Formatter) which is specified through the de.unkrig.commons.util.logging.FormatFormatter.format logging property.

Notice:
Since Java 7, the SimpleFormatter also has a '.format' property and thus implements the key feature of this class.

This class is a COPY of de.unkrig.ext.logging.formatter.PrintfFormatter, and should be kept in sync with that.

Field Summary

Fields

Modifier and Type	Field and Description
static PrintfFormatter	BENCHMARK Formats log records with the format string ""%12$s %10$-20s %3$2d %8$s%n"", which is very suitable for benchmarking.
static PrintfFormatter	COMPACT Formats log records with the format string ""%4$s %6$s::%7$s %8$s%9$s%n"", which produces a rather terse logging format.
static PrintfFormatter	DEFAULT The "default formatter", which is SIMPLE.
static String	FORMAT_STRING_BENCHMARK
static String	FORMAT_STRING_COMPACT
static String	FORMAT_STRING_MESSAGE
static String	FORMAT_STRING_MESSAGE_AND_EXCEPTION
static String	FORMAT_STRING_MESSAGE_AND_STACK_TRACE
static String	FORMAT_STRING_SIMPLE
static String	FORMAT_STRING_TIME_MESSAGE
static PrintfFormatter	MESSAGE Formats log records with the format string "%8$s%n" (which expands to the log message).
static PrintfFormatter	MESSAGE_AND_EXCEPTION Formats log records with the format string "%8$s%11$s%n" (which expands to the log message plus the (optional) exception name and message).
static PrintfFormatter	MESSAGE_AND_STACK_TRACE Formats log records with the format string "%8$s%9$s%n" (which expands to the log message, plus the (optional) exception name, message and stack trace).
static PrintfFormatter	SIMPLE Formats log records with the format string "%5$tF %5$tT.%5$tL %10$-20s %3$2d %8$s%9$s%n" (which produces a simple one-line format with date, time, simple class name, thread id, log message and the (optional) stack trace).
static PrintfFormatter	TIME_MESSAGE Formats log records with the format string "%5$tF %5$tT.%5$tL %8$s%n" (which produces a simple one-line format with date, time and log message).

Constructor Summary

Constructors

Modifier	Constructor and Description
	PrintfFormatter() The format string is retrieved from the "de.unkrig.commons.util.logging.formatter.PrintfFormatter.format" logging property.
protected	PrintfFormatter(int dummy, String propertyNamePrefix) Constructor for derived classes which wish to impose a different ".format" logging property than that used by PrintfFormatter().
	PrintfFormatter(String format) A format string with placeholders as described for format(LogRecord).

Method Summary

Modifier and Type	Method and Description
String	format(LogRecord record) Formats a LogRecord with a PRINTF format string.
String	getFormat()
void	setFormat(String format) Sets the format string for this logger.

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

FORMAT_STRING_BENCHMARK

public static final String FORMAT_STRING_BENCHMARK

See Also:

Constant Field Values

FORMAT_STRING_COMPACT

public static final String FORMAT_STRING_COMPACT

See Also:

Constant Field Values

FORMAT_STRING_MESSAGE

public static final String FORMAT_STRING_MESSAGE

See Also:

Constant Field Values

FORMAT_STRING_MESSAGE_AND_EXCEPTION

public static final String FORMAT_STRING_MESSAGE_AND_EXCEPTION

See Also:

Constant Field Values

FORMAT_STRING_MESSAGE_AND_STACK_TRACE

public static final String FORMAT_STRING_MESSAGE_AND_STACK_TRACE

See Also:

Constant Field Values

FORMAT_STRING_SIMPLE

public static final String FORMAT_STRING_SIMPLE

See Also:

Constant Field Values

FORMAT_STRING_TIME_MESSAGE

public static final String FORMAT_STRING_TIME_MESSAGE

See Also:

Constant Field Values

BENCHMARK

public static final PrintfFormatter BENCHMARK

Formats log records with the format string ""%12$s %10$-20s %3$2d %8$s%n"", which is very suitable for benchmarking.

Example:

     3.000000;    2.000000;    1.000000 MyClass               0 Message
 

COMPACT

public static final PrintfFormatter COMPACT

Formats log records with the format string ""%4$s %6$s::%7$s %8$s%9$s%n"", which produces a rather terse logging format.

Examples:

 FINE pkg.MyClass::main Log message #1

 FINE pkg.MyClass::main Log message #2
 java.io.IOException: Exception message
     at pkg.MyClass.main()
 

See Also:

format(LogRecord)

MESSAGE

public static final PrintfFormatter MESSAGE

Formats log records with the format string "%8$s%n" (which expands to the log message).

Example:

 Log message
 

See Also:

format(LogRecord)

MESSAGE_AND_EXCEPTION

public static final PrintfFormatter MESSAGE_AND_EXCEPTION

Formats log records with the format string "%8$s%11$s%n" (which expands to the log message plus the (optional) exception name and message).

Examples:

 Log message
 Log message: java.io.FileNotFoundException: Exception message
 

See Also:

format(LogRecord)

MESSAGE_AND_STACK_TRACE

public static final PrintfFormatter MESSAGE_AND_STACK_TRACE

Formats log records with the format string "%8$s%9$s%n" (which expands to the log message, plus the (optional) exception name, message and stack trace).

Examples:

 Log message #1

 Log message #2
 java.io.IOException: Exception message
     at pkg.MyClass.main()
 

See Also:

format(LogRecord)

SIMPLE

public static final PrintfFormatter SIMPLE

Formats log records with the format string "%5$tF %5$tT.%5$tL %10$-20s %3$2d %8$s%9$s%n" (which produces a simple one-line format with date, time, simple class name, thread id, log message and the (optional) stack trace).

Example:

 2012-03-08 10:10:28.515 MyClass               0 Log message #1

 2012-03-08 10:10:28.516 MyClass               0 Log message #2
 java.io.IOException: Exception message
     at pkg.MyClass.main()
 

See Also:

format(LogRecord)

TIME_MESSAGE

public static final PrintfFormatter TIME_MESSAGE

Formats log records with the format string "%5$tF %5$tT.%5$tL %8$s%n" (which produces a simple one-line format with date, time and log message).

Example:

 2012-12-31 23:59:59.999 Message
 

DEFAULT

public static final PrintfFormatter DEFAULT

The "default formatter", which is SIMPLE.

Constructor Detail

PrintfFormatter

public PrintfFormatter()

The format string is retrieved from the "de.unkrig.commons.util.logging.formatter.PrintfFormatter.format" logging property.

Logging properties are typically defined in the file "$JAVA_HOME/jre/lib/logging.properties".

See Also:

LogManager, Logger

PrintfFormatter

protected PrintfFormatter(int dummy,
                          @Nullable
                          String propertyNamePrefix)

Constructor for derived classes which wish to impose a different ".format" logging property than that used by PrintfFormatter().

Parameters:

dummy - Only there to distinguish this constructor from PrintfFormatter(String)

propertyNamePrefix - The property name prefix, or null to use the qualified name of the actual formatter class

See Also:

format(LogRecord)

PrintfFormatter

public PrintfFormatter(String format)

A format string with placeholders as described for format(LogRecord).

The following special format strings are recognized:

• SIMPLE
• MESSAGE_AND_EXCEPTION
• MESSAGE
• MESSAGE_AND_STACK_TRACE
• COMPACT
• null

See Also:

format(LogRecord)

Method Detail

setFormat

public final void setFormat(String format)

Sets the format string for this logger.

The following special format string values designate certain "predefined" formats:

• "BENCHMARK"
• "COMPACT"
• "MESSAGE"
• "MESSAGE_AND_EXCEPTION"
• "MESSAGE_AND_STACK_TRACE"
• "SIMPLE"
• null (means DEFAULT)
• "DEFAULT"

See Also:

The syntax of the format string, The arguments' meanings

getFormat

public String getFormat()

Returns:

The currently configured format string.

format

public String format(@Nullable
                     LogRecord record)

Formats a LogRecord with a PRINTF format string.

Placeholder	Description	Example
%1$d	Sequence number
%2$s	Logger name
%3$d	Thread ID	1
%4$s	Level	FINE
%5$tF %5$tT.%5$tL	Date/time	2012-03-08 10:10:28.468
%6$s	Source class name	pkg.MyClass
%7$s	Source method name	main
%8$s	Message
%9$s	The empty string iff the log record contains no throwable, otherwise: A colon A line break The throwable type name Another colon A space The throwable's message Another line break The throwable's stack trace (without the trailing line break)	preceding-text: pkg.MyException: Exception message at pkg.Class.method(File.java:123) at Main.main(Main.java:20)
%10$s	Simple source class name	MyClass
%11$s	Colon, space, throwable converted to string (typically class name, colon, space, localized message)	preceding-text: pkg.MyEception
%12$s	Real, CPU and user time in milliseconds since this thread last logged to this handler	3.000000; 2.000000; 1.000000
%n	Line separator
%%	Percent character ('%')

Specified by:

format in class Formatter