Module org.glassfish.main.jul

Package org.glassfish.main.jul.formatter

Class GlassFishLogFormatter

java.lang.Object

java.util.logging.Formatter

org.glassfish.main.jul.formatter.GlassFishLogFormatter

Direct Known Subclasses:

ODLLogFormatter, OneLineFormatter, UniformLogFormatter

public abstract class GlassFishLogFormatter
extends Formatter

A special Formatter able to notify some delegate about the LogRecord which passed through this instance.

Author:

David Matejcek

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GlassFishLogFormatter.GlassFishLogFormatterProperty	Configuration property set of this formatter

Field Summary

Fields

Modifier and Type	Field	Description
protected static final DateTimeFormatter	DEFAULT_DATETIME_FORMATTER	ISO-8601.
protected static final DateTimeFormatter	ISO_LOCAL_DATE_TIME	Example: 2011-12-03T15:35:40.123456
protected static final DateTimeFormatter	ISO_LOCAL_TIME	Example: 15:35:40.123456
protected static final MessageResolver	MSG_RESOLVER	Resolves LogRecord to GlassFishLogRecord

Constructor Summary

Constructors

Constructor	Description
GlassFishLogFormatter()	Creates an instance and initializes defaults from log manager's configuration
GlassFishLogFormatter(boolean printSource, DateTimeFormatter timestampFormatter)	Creates an instance and initializes defaults from log manager's configuration
GlassFishLogFormatter(HandlerId handlerId)	Creates an instance and initializes defaults from log manager's configuration
GlassFishLogFormatter(HandlerId handlerId, boolean printSource, DateTimeFormatter timestampFormatter)	Creates an instance and initializes defaults from log manager's configuration

Method Summary

Modifier and Type	Method	Description
final String	format(LogRecord record)
String	formatMessage(LogRecord record)
protected abstract String	formatRecord(LogRecord record)	Formats the record.
protected String	getPrintedMessage(GlassFishLogRecord record)
final DateTimeFormatter	getTimestampFormatter()
boolean	isPrintSequenceNumber()
boolean	isPrintSource()
void	setPrintSequenceNumber(boolean printSequenceNumber)
void	setPrintSource(boolean printSource)
final void	setTimestampFormatter(String format)
final void	setTimestampFormatter(DateTimeFormatter timestampFormatter)

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 Details

MSG_RESOLVER

protected static final MessageResolver MSG_RESOLVER

Resolves LogRecord to GlassFishLogRecord

ISO_LOCAL_TIME

protected static final DateTimeFormatter ISO_LOCAL_TIME

Example: 15:35:40.123456

ISO_LOCAL_DATE_TIME

protected static final DateTimeFormatter ISO_LOCAL_DATE_TIME

Example: 2011-12-03T15:35:40.123456

DEFAULT_DATETIME_FORMATTER

protected static final DateTimeFormatter DEFAULT_DATETIME_FORMATTER

ISO-8601. Example: 2011-12-03T15:35:40.123456+01:00

Constructor Details

GlassFishLogFormatter

public GlassFishLogFormatter(boolean printSource,
 DateTimeFormatter timestampFormatter)

Creates an instance and initializes defaults from log manager's configuration

Parameters:

printSource -

timestampFormatter -

GlassFishLogFormatter

public GlassFishLogFormatter(HandlerId handlerId,
 boolean printSource,
 DateTimeFormatter timestampFormatter)

Creates an instance and initializes defaults from log manager's configuration

Parameters:

handlerId -

printSource -

timestampFormatter -

GlassFishLogFormatter

public GlassFishLogFormatter(HandlerId handlerId)

Creates an instance and initializes defaults from log manager's configuration

Parameters:

handlerId -

GlassFishLogFormatter

public GlassFishLogFormatter()

Creates an instance and initializes defaults from log manager's configuration

Method Details

formatRecord

protected abstract String formatRecord(LogRecord record)

Formats the record.

Parameters:

record -

Returns:

formatted record, final record for output

setPrintSequenceNumber

public void setPrintSequenceNumber(boolean printSequenceNumber)

Parameters:

printSequenceNumber - true enables printing the log record sequence number

isPrintSequenceNumber

public boolean isPrintSequenceNumber()

Returns:

true enables printing the log record sequence number

setPrintSource

public void setPrintSource(boolean printSource)

Parameters:

printSource - if true, the source class and method will be printed to the output (but only if they are set)

isPrintSource

public boolean isPrintSource()

Returns:

if true, the source class and method will be printed to the output (but only if they are set)

getTimestampFormatter

public final DateTimeFormatter getTimestampFormatter()

Returns:

DateTimeFormatter used for timestamps

setTimestampFormatter

public final void setTimestampFormatter(DateTimeFormatter timestampFormatter)

Parameters:

timestampFormatter - DateTimeFormatter used for timestamps. Null sets default.

setTimestampFormatter

public final void setTimestampFormatter(String format)

Parameters:

format - The date format to set for records. Null sets default. See DateTimeFormatter for details.

formatMessage

public String formatMessage(LogRecord record)

Overrides:

formatMessage in class Formatter

format

public final String format(LogRecord record)

Specified by:

format in class Formatter

getPrintedMessage

protected String getPrintedMessage(GlassFishLogRecord record)

Parameters:

record - if null, this method returns null too

Returns:

a record's message plus printed stacktrace if some throwable is present.