Package com.unboundid.util

Class MinimalLogFormatter

java.lang.Object

java.util.logging.Formatter

com.unboundid.util.MinimalLogFormatter

All Implemented Interfaces:

Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class MinimalLogFormatter
extends Formatter
implements Serializable

This class provides a log formatter for use in the Java logging framework that may be used to minimize the formatting applied to log messages.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TIMESTAMP_FORMAT	The default format string that will be used for generating timestamps.

Constructor Summary

Constructors

Constructor	Description
MinimalLogFormatter()	Creates a new instance of this log formatter with the default settings.
MinimalLogFormatter(String timestampFormat, boolean includeLevel, boolean lineBreakAfterHeader, boolean lineBreakAfterMessage)	Creates a new instance of this log formatter with the provided configuration.

Method Summary

Modifier and Type	Method	Description
String	format(LogRecord record)	Formats the provided log record.

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 Details

DEFAULT_TIMESTAMP_FORMAT

@NotNull
public static final String DEFAULT_TIMESTAMP_FORMAT

The default format string that will be used for generating timestamps.

See Also:

• Constant Field Values

Constructor Details

MinimalLogFormatter

public MinimalLogFormatter()

Creates a new instance of this log formatter with the default settings. Generated messages will include a timestamp generated using the format string "'['dd/MMM/yyyy:HH:mm:ss Z']'", will not include the log level, and will not include a line break after the timestamp or the message.

MinimalLogFormatter

public MinimalLogFormatter(@Nullable
 String timestampFormat,
 boolean includeLevel,
 boolean lineBreakAfterHeader,
 boolean lineBreakAfterMessage)

Creates a new instance of this log formatter with the provided configuration.

Parameters:

timestampFormat - The format string used to generate timestamps. If this is null, then timestamps will not be included in log messages.

includeLevel - Indicates whether to include the log level in the generated messages.

lineBreakAfterHeader - Indicates whether to insert a line break after the timestamp and/or log level.

lineBreakAfterMessage - Indicates whether to insert aline break after the generated message.

Method Details

format

@NotNull
public String format(@NotNull
 LogRecord record)

Formats the provided log record.

Specified by:

format in class Formatter

Parameters:

record - The log record to be formatted.

Returns:

A string containing the formatted log record.