Package org.apache.juneau.marshall

Enum Class DateFormat

java.lang.Object

java.lang.Enum<DateFormat>

org.apache.juneau.marshall.DateFormat

All Implemented Interfaces:

Serializable, Comparable<DateFormat>, Constable

public enum DateFormat
extends Enum<DateFormat>

Supported wire formats for Date values.

Used by MarshallingContext.Builder.dateFormat(DateFormat), Marshalled.dateFormat(), MarshalledProp.dateFormat(), and MarshalledConfig.dateFormat() to control how Date values are written to and read from the wire.

The default is ISO_LOCAL_DATE_TIME which preserves the historical wire output produced before this enum existed (note: Date carries no zone so the default emits a local date-time, deliberately differing from CalendarFormat.ISO_OFFSET_DATE_TIME).

Numeric formats (MILLIS) emit native numeric wire types on binary serializers (BSON / CBOR / MsgPack) and bare numbers on text formats. Text formats emit a quoted ISO 8601 string for every other constant.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASIC_ISO_DATE	DateTimeFormatter.BASIC_ISO_DATE: "20111203".
ISO_DATE	DateTimeFormatter.ISO_DATE: "2011-12-03+01:00" or "2011-12-03".
ISO_DATE_TIME	DateTimeFormatter.ISO_DATE_TIME: "2011-12-03T10:15:30+01:00[Europe/Paris]".
ISO_INSTANT	DateTimeFormatter.ISO_INSTANT: "2011-12-03T10:15:30Z".
ISO_LOCAL_DATE	DateTimeFormatter.ISO_LOCAL_DATE: "2011-12-03".
ISO_LOCAL_DATE_TIME	DateTimeFormatter.ISO_LOCAL_DATE_TIME (the default): "2011-12-03T10:15:30".
ISO_LOCAL_TIME	DateTimeFormatter.ISO_LOCAL_TIME: "10:15:30".
ISO_OFFSET_DATE	DateTimeFormatter.ISO_OFFSET_DATE: "2011-12-03+01:00".
ISO_OFFSET_DATE_TIME	DateTimeFormatter.ISO_OFFSET_DATE_TIME: "2011-12-03T10:15:30+01:00".
ISO_OFFSET_TIME	DateTimeFormatter.ISO_OFFSET_TIME: "10:15:30+01:00".
ISO_ORDINAL_DATE	DateTimeFormatter.ISO_ORDINAL_DATE: "2012-337".
ISO_TIME	DateTimeFormatter.ISO_TIME: "10:15:30+01:00" or "10:15:30".
ISO_WEEK_DATE	DateTimeFormatter.ISO_WEEK_DATE: "2012-W48-6".
ISO_ZONED_DATE_TIME	DateTimeFormatter.ISO_ZONED_DATE_TIME: "2011-12-03T10:15:30+01:00[Europe/Paris]".
MILLIS	Epoch milliseconds as a numeric value.
NOT_SET	Sentinel meaning "no value configured" — falls through to the next-higher precedence level.
RFC_1123_DATE_TIME	DateTimeFormatter.RFC_1123_DATE_TIME: "Tue, 3 Jun 2008 11:05:30 GMT".

Method Summary

Modifier and Type	Method	Description
String	format(Date value, ZoneId zoneId)	Formats the specified value using this format.
boolean	isNumeric()	Returns true if this format is numeric on the wire.
Date	parse(String value, ZoneId zoneId)	Parses the specified wire value using this format.
static DateFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DateFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOT_SET

public static final DateFormat NOT_SET

Sentinel meaning "no value configured" — falls through to the next-higher precedence level.

BASIC_ISO_DATE

public static final DateFormat BASIC_ISO_DATE

DateTimeFormatter.BASIC_ISO_DATE: "20111203".

ISO_DATE

public static final DateFormat ISO_DATE

DateTimeFormatter.ISO_DATE: "2011-12-03+01:00" or "2011-12-03".

ISO_DATE_TIME

public static final DateFormat ISO_DATE_TIME

DateTimeFormatter.ISO_DATE_TIME: "2011-12-03T10:15:30+01:00[Europe/Paris]".

ISO_INSTANT

public static final DateFormat ISO_INSTANT

DateTimeFormatter.ISO_INSTANT: "2011-12-03T10:15:30Z".

ISO_LOCAL_DATE

public static final DateFormat ISO_LOCAL_DATE

DateTimeFormatter.ISO_LOCAL_DATE: "2011-12-03".

ISO_LOCAL_DATE_TIME

public static final DateFormat ISO_LOCAL_DATE_TIME

DateTimeFormatter.ISO_LOCAL_DATE_TIME (the default): "2011-12-03T10:15:30".

ISO_LOCAL_TIME

public static final DateFormat ISO_LOCAL_TIME

DateTimeFormatter.ISO_LOCAL_TIME: "10:15:30".

ISO_OFFSET_DATE

public static final DateFormat ISO_OFFSET_DATE

DateTimeFormatter.ISO_OFFSET_DATE: "2011-12-03+01:00".

ISO_OFFSET_DATE_TIME

public static final DateFormat ISO_OFFSET_DATE_TIME

DateTimeFormatter.ISO_OFFSET_DATE_TIME: "2011-12-03T10:15:30+01:00".

ISO_OFFSET_TIME

public static final DateFormat ISO_OFFSET_TIME

DateTimeFormatter.ISO_OFFSET_TIME: "10:15:30+01:00".

ISO_ORDINAL_DATE

public static final DateFormat ISO_ORDINAL_DATE

DateTimeFormatter.ISO_ORDINAL_DATE: "2012-337".

ISO_TIME

public static final DateFormat ISO_TIME

DateTimeFormatter.ISO_TIME: "10:15:30+01:00" or "10:15:30".

ISO_WEEK_DATE

public static final DateFormat ISO_WEEK_DATE

DateTimeFormatter.ISO_WEEK_DATE: "2012-W48-6".

ISO_ZONED_DATE_TIME

public static final DateFormat ISO_ZONED_DATE_TIME

DateTimeFormatter.ISO_ZONED_DATE_TIME: "2011-12-03T10:15:30+01:00[Europe/Paris]".

RFC_1123_DATE_TIME

public static final DateFormat RFC_1123_DATE_TIME

DateTimeFormatter.RFC_1123_DATE_TIME: "Tue, 3 Jun 2008 11:05:30 GMT".

MILLIS

public static final DateFormat MILLIS

Epoch milliseconds as a numeric value.

Emitted as a native int64 by binary serializers (BSON / CBOR / MsgPack) and as a bare integer literal by text serializers.

Method Details

values

public static DateFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DateFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

format

public String format(Date value,
 ZoneId zoneId)

Formats the specified value using this format.

Parameters:

value - The value to format. Can be null (returns null).

zoneId - The default zone id used to interpret the date.

Returns:

The formatted string, or null if value is null.

parse

public Date parse(String value,
 ZoneId zoneId)

Parses the specified wire value using this format.

Parameters:

value - The wire value. Can be null or blank (returns null).

zoneId - The default zone id used for time-only / unzoned values.

Returns:

The parsed Date, or null if value is null or blank.

isNumeric

public boolean isNumeric()

Returns true if this format is numeric on the wire.

Returns:

true if this format emits a numeric wire value.