org.apache.logging.log4j.core.util.datetime

Class FixedDateFormat

java.lang.Object

org.apache.logging.log4j.core.util.datetime.FixedDateFormat

public class FixedDateFormat
extends Object

Custom time formatter that trades flexibility for performance. This formatter only supports the date patterns defined in FixedDateFormat.FixedFormat. For any other date patterns use FastDateFormat.

Related benchmarks: /log4j-perf/src/main/java/org/apache/logging/log4j/perf/jmh/TimeFormatBenchmark.java and /log4j-perf/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadsafeDateFormatBenchmark.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FixedDateFormat.FixedFormat Enumeration over the supported date/time format patterns.

Method Summary

Methods

Modifier and Type	Method and Description
static FixedDateFormat	create(FixedDateFormat.FixedFormat format) Returns a new FixedDateFormat object for the specified FixedFormat and a TimeZone.getDefault() TimeZone.
static FixedDateFormat	create(FixedDateFormat.FixedFormat format, TimeZone tz) Returns a new FixedDateFormat object for the specified FixedFormat and TimeZone.
static FixedDateFormat	createIfSupported(String... options)
String	format(long time)
int	format(long time, char[] buffer, int startPos)
String	getFormat() Returns the full pattern of the selected fixed format.
TimeZone	getTimeZone() Returns the time zone.

Methods inherited from class java.lang.Object

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

Method Detail

createIfSupported

public static FixedDateFormat createIfSupported(String... options)

create

public static FixedDateFormat create(FixedDateFormat.FixedFormat format)

Returns a new FixedDateFormat object for the specified FixedFormat and a TimeZone.getDefault() TimeZone.

Parameters:

format - the format to use

Returns:

a new FixedDateFormat object

create

public static FixedDateFormat create(FixedDateFormat.FixedFormat format,
                     TimeZone tz)

Returns a new FixedDateFormat object for the specified FixedFormat and TimeZone.

Parameters:

format - the format to use

tz - the time zone to use

Returns:

a new FixedDateFormat object

getFormat

public String getFormat()

Returns the full pattern of the selected fixed format.

Returns:

the full date-time pattern

getTimeZone

public TimeZone getTimeZone()

Returns the time zone.

Returns:

the time zone

format

public String format(long time)

format

public int format(long time,
         char[] buffer,
         int startPos)