com.sun.mail.util.logging

Class CompactFormatter

java.lang.Object

java.util.logging.Formatter

com.sun.mail.util.logging.CompactFormatter

public class CompactFormatter
extends java.util.logging.Formatter

A plain text formatter that can produce fixed width output. By default this formatter will produce output no greater than 160 characters wide. Only specified fields support an alternate fixed width format.

The LogManager properties are:

• <formatter-name>.format - the format string used to transform the output. The format string can be used to fix the output size. (defaults to "%7$#.160s%n")

Since:

JavaMail 1.5.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	CompactFormatter.Alternate Used to format two arguments as fixed length message.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	fmt Holds the java.util.Formatter pattern.

Constructor Summary

Constructors

Constructor and Description
CompactFormatter() Creates an instance with a default format pattern.
CompactFormatter(java.lang.String format) Creates an instance with the given format pattern.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Throwable	apply(java.lang.Throwable t) Chooses a single throwable from the cause chain that will be formatted.
private boolean	defaultIgnore(java.lang.StackTraceElement s) Determines if a stack frame should be ignored as the cause of an error.
private java.lang.String	findAndFormat(java.lang.StackTraceElement[] trace) Finds and formats the first stack frame of interest.
java.lang.String	format(java.util.logging.LogRecord record) Format the given log record and returns the formatted string.
java.lang.String	formatBackTrace(java.util.logging.LogRecord record) Formats the back trace for the given log record.
java.lang.String	formatLevel(java.util.logging.LogRecord record) Formats the level property of the given log record.
java.lang.String	formatLoggerName(java.util.logging.LogRecord record) Formats the logger name property of the given log record.
java.lang.String	formatMessage(java.util.logging.LogRecord record) Formats message for the log record.
java.lang.String	formatMessage(java.lang.Throwable t) Formats the message from the thrown property of the log record.
java.lang.String	formatSource(java.util.logging.LogRecord record) Formats the source from the given log record.
private java.lang.String	formatStackTraceElement(java.lang.StackTraceElement s) Formats a stack trace element into a simple call site.
java.lang.String	formatThrown(java.util.logging.LogRecord record) Formats the thrown property of a LogRecord.
protected boolean	ignore(java.lang.StackTraceElement s) Determines if a stack frame should be ignored as the cause of an error.
private java.lang.String	initFormat(java.lang.String p) Creates the format pattern for this formatter.
private static boolean	isNullOrSpaces(java.lang.String s) Determines is the given string is null or spaces.
private boolean	isReflection(java.lang.StackTraceElement s) Determines if a stack trace element represents a reflection frame.
private boolean	isStaticUtility(java.lang.StackTraceElement s) Determines if a stack frame is for a static utility class.
private boolean	isSynthetic(java.lang.StackTraceElement s) Determines if a stack trace element is for a synthetic method.
private boolean	isUnknown(java.lang.StackTraceElement s) Determines if a stack trace element has an unknown line number or a native line number.
private static java.lang.String	replaceClassName(java.lang.String msg, java.lang.Object[] p) Searches the given message for all instances fully qualified class name with simple class name based off of the types contained in the given parameter array.
private static java.lang.String	replaceClassName(java.lang.String msg, java.lang.Throwable t) Searches the given message for all instances fully qualified class name with simple class name based off of the types contained in the given parameter array.
private static java.lang.String	simpleClassName(java.lang.String name) Converts a fully qualified class name to a simple class name.
private static java.lang.String	simpleFileName(java.lang.String name) Converts a file name with an extension to a file name without an extension.
protected java.lang.String	toAlternate(java.lang.String s) Defines the alternate format.

Methods inherited from class java.util.logging.Formatter

getHead, getTail

Methods inherited from class java.lang.Object

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

Field Detail

fmt

private final java.lang.String fmt

Holds the java.util.Formatter pattern.

Constructor Detail

CompactFormatter

public CompactFormatter()

Creates an instance with a default format pattern.

CompactFormatter

public CompactFormatter(java.lang.String format)

Creates an instance with the given format pattern.

Parameters:

format - the pattern or null to use the LogManager default. The arguments are described in the format method.

Method Detail

format

public java.lang.String format(java.util.logging.LogRecord record)

Format the given log record and returns the formatted string. The java.util argument indexes are assigned to the following properties:

0. 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.
1. date - a Date object representing event time of the log record.
2. source - a string representing the caller, if available; otherwise, the logger's name.
3. logger - the logger's name.
4. level - the log level.
5. message - the formatted log message returned from the formatMessage(LogRecord) method.
6. 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.
7. message|thrown The message and the thrown properties joined as one parameter. This parameter supports alternate form.
8. thrown|message The thrown and message properties joined as one parameter. This parameter supports alternate form.

Specified by:

format in class java.util.logging.Formatter

Parameters:

record - to format.

Returns:

the formatted record.

Throws:

java.lang.NullPointerException - if the given record is null.

formatMessage

public java.lang.String formatMessage(java.util.logging.LogRecord record)

Formats message for the log record. This method removes any fully qualified throwable class names from the message.

Overrides:

formatMessage in class java.util.logging.Formatter

Parameters:

record - the log record.

Returns:

the formatted message string.

formatMessage

public java.lang.String formatMessage(java.lang.Throwable t)

Formats the message from the thrown property of the log record. This method removes any fully qualified throwable class names from the message cause chain.

Parameters:

t - the throwable to format.

Returns:

the formatted message string from the throwable.

formatLevel

public java.lang.String formatLevel(java.util.logging.LogRecord record)

Formats the level property of the given log record.

Parameters:

record - the record.

Returns:

the formatted logger name.

Throws:

java.lang.NullPointerException - if the given record is null.

formatSource

public java.lang.String formatSource(java.util.logging.LogRecord record)

Formats the source from the given log record.

Parameters:

record - the record.

Returns:

the formatted source of the log record.

Throws:

java.lang.NullPointerException - if the given record is null.

formatLoggerName

public java.lang.String formatLoggerName(java.util.logging.LogRecord record)

Formats the logger name property of the given log record.

Parameters:

record - the record.

Returns:

the formatted logger name.

Throws:

java.lang.NullPointerException - if the given record is null.

formatThrown

public java.lang.String formatThrown(java.util.logging.LogRecord record)

Formats the thrown property of a LogRecord. The returned string will contain a throwable message with a back trace.

Parameters:

record - the record.

Returns:

empty string if nothing was thrown or formatted string.

Throws:

java.lang.NullPointerException - if the given record is null.

See Also:

apply(java.lang.Throwable), formatBackTrace(java.util.logging.LogRecord)

formatBackTrace

public java.lang.String formatBackTrace(java.util.logging.LogRecord record)

Formats the back trace for the given log record.

Parameters:

record - the log record to format.

Returns:

the formatted back trace.

Throws:

java.lang.NullPointerException - if the given record is null.

See Also:

apply(java.lang.Throwable), formatThrown(java.util.logging.LogRecord), ignore(java.lang.StackTraceElement)

findAndFormat

private java.lang.String findAndFormat(java.lang.StackTraceElement[] trace)

Finds and formats the first stack frame of interest.

Parameters:

trace - the fill stack to examine.

Returns:

a String that best describes the call site.

Throws:

java.lang.NullPointerException - if stack trace element array is null.

formatStackTraceElement

private java.lang.String formatStackTraceElement(java.lang.StackTraceElement s)

Formats a stack trace element into a simple call site.

Parameters:

s - the stack trace element to format.

Returns:

the formatted stack trace element.

Throws:

java.lang.NullPointerException - if stack trace element is null.

See Also:

formatThrown(java.util.logging.LogRecord)

apply

protected java.lang.Throwable apply(java.lang.Throwable t)

Chooses a single throwable from the cause chain that will be formatted. This implementation chooses the throwable that best describes the chain. Subclasses can override this method to choose an alternate throwable for formatting.

Parameters:

t - the throwable from the log record.

Returns:

the throwable or null.

See Also:

formatThrown(java.util.logging.LogRecord)

ignore

protected boolean ignore(java.lang.StackTraceElement s)

Determines if a stack frame should be ignored as the cause of an error.

Parameters:

s - the stack trace element.

Returns:

true if this frame should be ignored.

See Also:

formatThrown(java.util.logging.LogRecord)

toAlternate

protected java.lang.String toAlternate(java.lang.String s)

Defines the alternate format. This implementation removes all control characters from the given string.

Parameters:

s - any string or null.

Returns:

null if the argument was null otherwise, an alternate string.

defaultIgnore

private boolean defaultIgnore(java.lang.StackTraceElement s)

Determines if a stack frame should be ignored as the cause of an error. This does not check for unknown line numbers because code can be compiled without debugging info.

Parameters:

s - the stack trace element.

Returns:

true if this frame should be ignored.

isStaticUtility

private boolean isStaticUtility(java.lang.StackTraceElement s)

Determines if a stack frame is for a static utility class.

Parameters:

s - the stack trace element.

Returns:

true if this frame should be ignored.

isSynthetic

private boolean isSynthetic(java.lang.StackTraceElement s)

Determines if a stack trace element is for a synthetic method.

Parameters:

s - the stack trace element.

Returns:

true if synthetic.

Throws:

java.lang.NullPointerException - if stack trace element is null.

isUnknown

private boolean isUnknown(java.lang.StackTraceElement s)

Determines if a stack trace element has an unknown line number or a native line number.

Parameters:

s - the stack trace element.

Returns:

true if the line number is unknown.

Throws:

java.lang.NullPointerException - if stack trace element is null.

isReflection

private boolean isReflection(java.lang.StackTraceElement s)

Determines if a stack trace element represents a reflection frame.

Parameters:

s - the stack trace element.

Returns:

true if the line number is unknown.

Throws:

java.lang.NullPointerException - if stack trace element is null.

initFormat

private java.lang.String initFormat(java.lang.String p)

Creates the format pattern for this formatter.

Parameters:

p - the class name prefix.

Returns:

the java.util.Formatter format string.

Throws:

java.lang.NullPointerException - if the given class name is null.

replaceClassName

private static java.lang.String replaceClassName(java.lang.String msg,
                                                 java.lang.Throwable t)

Searches the given message for all instances fully qualified class name with simple class name based off of the types contained in the given parameter array.

Parameters:

msg - the message.

t - the throwable cause chain to search or null.

Returns:

the modified message string.

replaceClassName

private static java.lang.String replaceClassName(java.lang.String msg,
                                                 java.lang.Object[] p)

Searches the given message for all instances fully qualified class name with simple class name based off of the types contained in the given parameter array.

Parameters:

msg - the message or null.

p - the parameter array or null.

Returns:

the modified message string.

simpleClassName

private static java.lang.String simpleClassName(java.lang.String name)

Converts a fully qualified class name to a simple class name.

Parameters:

name - the fully qualified class name or null.

Returns:

the simple class name or null.

simpleFileName

private static java.lang.String simpleFileName(java.lang.String name)

Converts a file name with an extension to a file name without an extension.

Parameters:

name - the full file name or null.

Returns:

the simple file name or null.

isNullOrSpaces

private static boolean isNullOrSpaces(java.lang.String s)

Determines is the given string is null or spaces.

Parameters:

s - the string or null.

Returns:

true if null or spaces.