logahawk.formatters
Class DateArgFormatter

java.lang.Object
  logahawk.formatters.DateArgFormatter

All Implemented Interfaces:

ArgumentFormatter

@Immutable
public class DateArgFormatter
extends Object
implements ArgumentFormatter

This formatter can handle Date objects.

Field Summary

protected DateFormat	dateFormat
static DateFormat	STD_DATE_FORMAT The default date format.

Constructor Summary

DateArgFormatter()

DateArgFormatter(DateFormat dateFormat)

Method Summary

boolean	canFormat(Object obj) This class can handle any normal type of collection.
String	format(Object obj, Collection<ArgumentFormatter> formatters, int indentLevel) This converts the object into a String that represent the object.
DateFormat	getDateFormat() The "DateArgFormatter" is what we use to format the epoch of a log message.

Methods inherited from class java.lang.Object

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

Field Detail

STD_DATE_FORMAT

public static final DateFormat STD_DATE_FORMAT

The default date format. This is the familiar TZ format.

dateFormat

protected final DateFormat dateFormat

Constructor Detail

DateArgFormatter

public DateArgFormatter()

DateArgFormatter

public DateArgFormatter(DateFormat dateFormat)

Parameters:

dateFormat - A clone of this DateFormat will be created (because DateFormats are not inherently thread safe.

Method Detail

canFormat

public boolean canFormat(Object obj)

This class can handle any normal type of collection.

Specified by:

canFormat in interface ArgumentFormatter

format

public String format(Object obj,
                     Collection<ArgumentFormatter> formatters,
                     int indentLevel)

Description copied from interface: ArgumentFormatter

This converts the object into a String that represent the object. The String may contain line breaks, but should not include a trailing line break. The first line of the result should NOT include any indentation, that should be handled by the calling class. If the object is complex and contains other objects, this ArgumentFormatter may use the provided list of ArgumentFormatter objects to find a more appropriate formatter. To make things look nice, the "indentLevel" is provided. The indent level should always be incremented by one when calling downward into other ArgumentFormatters.

Specified by:

format in interface ArgumentFormatter

getDateFormat

public DateFormat getDateFormat()

The "DateArgFormatter" is what we use to format the epoch of a log message.