public class CompactFormatter extends Formatter
By default each CompactFormatter is initialized using the following LogManager configuration properties where <formatter-name> refers to the fully qualified class name or the fully qualified derived class name of the formatter. If properties are not defined, or contain invalid values, then the specified default values are used.
Constructor and Description |
---|
CompactFormatter()
Creates an instance with a default format pattern.
|
CompactFormatter(String format)
Creates an instance with the given format pattern.
|
Modifier and Type | Method and Description |
---|---|
protected Throwable |
apply(Throwable t)
Chooses a single throwable from the cause chain that will be formatted.
|
String |
format(LogRecord record)
Format the given log record and returns the formatted string.
|
String |
formatBackTrace(LogRecord record)
Formats the back trace for the given log record.
|
String |
formatError(LogRecord record)
Formats the thrown property of a LogRecord as an error message.
|
String |
formatLevel(LogRecord record)
Formats the level property of the given log record.
|
String |
formatLoggerName(LogRecord record)
Formats the logger name property of the given log record.
|
String |
formatMessage(LogRecord record)
Formats message for the log record.
|
String |
formatMessage(Throwable t)
Formats the message from the thrown property of the log record.
|
String |
formatSource(LogRecord record)
Formats the source from the given log record.
|
Number |
formatThreadID(LogRecord record)
Formats the thread id property of the given log record.
|
String |
formatThrown(LogRecord record)
Formats the thrown property of a LogRecord.
|
protected boolean |
ignore(StackTraceElement s)
Determines if a stack frame should be ignored as the cause of an error.
|
protected String |
toAlternate(String s)
Defines the alternate format.
|
public CompactFormatter()
public String format(LogRecord record)
format
- the java.util.Formatter format string specified in the
<formatter-name>.format property or the format that was given when
this formatter was created.date
- if the log record supports nanoseconds then a
ZonedDateTime object representing the event time of the log record in
the system time zone. Otherwise, a Date object
representing event time of the log
record.source
- a string representing the caller, if available;
otherwise, the logger's name.logger
- the logger's
name.level
- the
log level.message
- the formatted log message returned from the
formatMessage(LogRecord) method.thrown
- a string representing the
throwable associated with the log record
and a relevant stack trace element if available; otherwise, an empty
string is used.message|thrown
The message and the thrown properties joined
as one parameter. This parameter supports
alternate form.thrown|message
The thrown and message properties joined as
one parameter. This parameter supports
alternate form.sequence
the
sequence number if the given
log record.thread id
the thread id
of the given log record. By default this is formatted as a long
by an unsigned conversion.error
the throwable simple class name and
error message without any
stack trace.message|error
The message and error properties joined as
one parameter. This parameter supports
alternate form.error|message
The error and message properties joined as
one parameter. This parameter supports
alternate form.backtrace
only the
stack trace of the given
throwable.bundlename
the resource bundle
name of the given log
record.key
the raw message
before localization or formatting.
Some example formats:
com.sun.mail.util.logging.CompactFormatter.format=%7$#.160s%n
This prints only 160 characters of the message|thrown (7$
) using
the alternate form. The
separator is not included as part of the total width.
Encoding failed.|NullPointerException: null String.getBytes(:913)
com.sun.mail.util.logging.CompactFormatter.format=%7$#.20s%n
This prints only 20 characters of the message|thrown (7$
) using
the alternate form. This
will perform a weighted truncation of both the message and thrown
properties of the log record. The separator is not included as part of
the total width.
Encoding|NullPointerE
com.sun.mail.util.logging.CompactFormatter.format=%1$tc %2$s%n%4$s: %5$s%6$s%n
This prints the timestamp (1$
) and the source (2$
) on the
first line. The second line is the log level (4$
), log message
(5$
), and the throwable with a relevant stack trace element
(6$
) if one is available.
Fri Nov 20 07:29:24 CST 2009 MyClass fatal SEVERE: Encoding failed.NullPointerException: null String.getBytes(:913)
com.sun.mail.util.logging.CompactFormatter.format=%4$s: %12$#.160s%n
This prints the log level (4$
) and only 160 characters of the
message|error (12$
) using the alternate form.
SEVERE: Unable to send notification.|SocketException: Permission denied: connect
com.sun.mail.util.logging.CompactFormatter.format=[%9$d][%1$tT][%10$d][%2$s] %5$s%n%6$s%n
This prints the sequence (9$
), event time (1$
) as
24 hour time, thread id (10$
), source (2$
), log message
(5$
), and the throwable with back trace (6$
).
[125][14:11:42][38][MyClass fatal] Unable to send notification. SocketException: Permission denied: connect SMTPTransport.openServer(:1949)
format
in class Formatter
record
- the log record to format.NullPointerException
- if the given record is null.public String formatMessage(LogRecord record)
formatMessage
in class Formatter
record
- the log record.public String formatMessage(Throwable t)
t
- the throwable to format or null.public String formatLevel(LogRecord record)
record
- the record.NullPointerException
- if the given record is null.public String formatSource(LogRecord record)
record
- the record.NullPointerException
- if the given record is null.public String formatLoggerName(LogRecord record)
record
- the record.NullPointerException
- if the given record is null.public Number formatThreadID(LogRecord record)
long
by an unsigned conversion.record
- the record.NullPointerException
- if the given record is null.public String formatThrown(LogRecord record)
record
- the record.NullPointerException
- if the given record is null.apply(java.lang.Throwable)
,
formatBackTrace(java.util.logging.LogRecord)
public String formatError(LogRecord record)
record
- the record.NullPointerException
- if the given record is null.Throwable.toString()
,
apply(java.lang.Throwable)
,
formatMessage(java.lang.Throwable)
public String formatBackTrace(LogRecord record)
record
- the log record to format.NullPointerException
- if the given record is null.apply(java.lang.Throwable)
,
formatThrown(java.util.logging.LogRecord)
,
ignore(java.lang.StackTraceElement)
protected Throwable apply(Throwable t)
t
- the throwable from the log record.formatThrown(java.util.logging.LogRecord)
protected boolean ignore(StackTraceElement s)
s
- the stack trace element.formatThrown(java.util.logging.LogRecord)
Copyright © 2017 JBoss by Red Hat. All rights reserved.