com.sun.mail.util.logging

Class CollectorFormatter

java.lang.Object

java.util.logging.Formatter

com.sun.mail.util.logging.CollectorFormatter

public class CollectorFormatter
extends Formatter

A LogRecord formatter that takes a sequence of LogRecords and combines them into a single summary result. Formating of the head, LogRecord, and tail are delegated to the wrapped formatter.

The LogManager properties are:

• <formatter-name>.comparator name of a Comparator class used to choose the collected LogRecord. If a comparator is specified then the max LogRecord is chosen. If comparator is set to the string literal null, then the last record is chosen. (defaults to SeverityComparator)
• <formatter-name>.comparator.reverse a boolean true to collect the min LogRecord or false to collect the max LogRecord. (defaults to false)
• <formatter-name>.format the MessageFormat string used to format the collected summary statistics. The arguments are explained in detail in the getTail documentation. (defaults to "{0}{1}{2}{4,choice,-1#|0#|0<... {4,number,integer} more}\n")
• <formatter-name>.formatter name of a Formatter class used to format the collected LogRecord. (defaults to CompactFormatter)

Since:

JavaMail 1.5.2

Author:

Jason Mehrens

Constructor Summary

Constructors

Constructor and Description
CollectorFormatter() Creates the formatter using the LogManager defaults.
CollectorFormatter(String format) Creates the formatter using the given format.
CollectorFormatter(String format, Formatter f, Comparator<? super LogRecord> c) Creates the formatter using the given values.

Method Summary

Methods

Modifier and Type	Method and Description
protected LogRecord	apply(LogRecord t, LogRecord u) Used to choose the collected LogRecord.
protected String	finish(String s) Applied to the head, format, and tail returned by the target formatter.
String	format(LogRecord record) Accumulates log records which will be used to produce the final output.
String	getTail(Handler h) Formats the collected LogRecord and summary statistics.
String	toString() Formats the collected LogRecord and summary statistics.

Methods inherited from class java.util.logging.Formatter

formatMessage, getHead

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectorFormatter

public CollectorFormatter()

Creates the formatter using the LogManager defaults.

Throws:

SecurityException - if a security manager exists and the caller does not have LoggingPermission("control").

UndeclaredThrowableException - if there are problems loading from the LogManager.

CollectorFormatter

public CollectorFormatter(String format)

Creates the formatter using the given format.

Parameters:

format - the message format or null to use the LogManager default.

Throws:

SecurityException - if a security manager exists and the caller does not have LoggingPermission("control").

UndeclaredThrowableException - if there are problems loading from the LogManager.

CollectorFormatter

public CollectorFormatter(String format,
                  Formatter f,
                  Comparator<? super LogRecord> c)

Creates the formatter using the given values.

Parameters:

format - the format string or null to use the LogManager default.

f - the formatter used on the collected log record or null to specify no formatter.

c - the comparator used to determine which log record to format or null to specify no comparator.

Throws:

SecurityException - if a security manager exists and the caller does not have LoggingPermission("control").

UndeclaredThrowableException - if there are problems loading from the LogManager.

Method Detail

format

public String format(LogRecord record)

Accumulates log records which will be used to produce the final output. The output is generated using the getTail(java.util.logging.Handler) method which also resets this formatter back to its original state.

Specified by:

format in class Formatter

Parameters:

record - the record to store.

Returns:

an empty string.

Throws:

NullPointerException - if the given record is null.

getTail

public String getTail(Handler h)

Formats the collected LogRecord and summary statistics. The collected results are reset after calling this method. The java.text argument indexes are assigned to the following properties:

0. head the head string returned from the target formatter and finished by this formatter.
1. formatted the current log record formatted by the target formatter and finished by this formatter.
2. tail the tail string returned from the target formatter and finished by this formatter.
3. count the total number of log records consumed by this formatter.
4. remaining the count minus one.
5. thrown the total number of log records consumed by this formatter with an assigned throwable.
6. normal messages the count minus the thrown.
7. minMillis the eldest log record event time consumed by this formatter. If no records were formatted then this is set to the approximate start time of the JVM. By default this parameter is defined as a number. The format type and format style rules from the MessageFormat should be used to convert this to a date or time.
8. maxMillis the most recent log record event time consumed by this formatter. If no records were formatted then this is set to the current time. By default this parameter is defined as a number. The format type and format style rules from the MessageFormat should be used to convert this to a date or time.

Overrides:

getTail in class Formatter

Parameters:

h - the handler or null.

Returns:

the output string.

toString

public String toString()

Formats the collected LogRecord and summary statistics. The LogRecord and summary statistics are not changed by calling this method.

Overrides:

toString in class Object

Returns:

the current record formatted or the default toString.

See Also:

getTail(java.util.logging.Handler)

apply

protected LogRecord apply(LogRecord t,
              LogRecord u)

Used to choose the collected LogRecord. This implementation returns the greater of two LogRecords.

Parameters:

t - the current record.

u - the record that could replace the current.

Returns:

the greater of the given log records.

Throws:

NullPointerException - may occur if either record is null.

finish

protected String finish(String s)

Applied to the head, format, and tail returned by the target formatter. This implementation trims all input strings.

Parameters:

s - the string to transform.

Returns:

the transformed string.

Throws:

NullPointerException - if the given string is null.