Package org.apache.juneau.marshall

Enum Class CalendarFormat

java.lang.Object

java.lang.Enum<CalendarFormat>

org.apache.juneau.marshall.CalendarFormat

All Implemented Interfaces:

Serializable, Comparable<CalendarFormat>, Constable

public enum CalendarFormat
extends Enum<CalendarFormat>

Supported wire formats for Calendar values.

Used by MarshallingContext.Builder.calendarFormat(CalendarFormat), Marshalled.calendarFormat(), MarshalledProp.calendarFormat(), and MarshalledConfig.calendarFormat() to control how Calendar values (including GregorianCalendar) are written to and read from the wire.

The default is ISO_OFFSET_DATE_TIME which preserves the historical wire output produced before this enum existed.

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.

XMLGregorianCalendar fields always emit toXMLFormat() regardless of the configured CalendarFormat. The XML_FORMAT constant exists so that regular Calendar / GregorianCalendar fields can opt into the same wire form for symmetry with their XMLGregorianCalendar siblings.

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: "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 (the default): "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".
XML_FORMAT	XML Schema dateTime form.

Method Summary

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

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 CalendarFormat NOT_SET

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

BASIC_ISO_DATE

public static final CalendarFormat BASIC_ISO_DATE

DateTimeFormatter.BASIC_ISO_DATE: "20111203".

ISO_DATE

public static final CalendarFormat ISO_DATE

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

ISO_DATE_TIME

public static final CalendarFormat ISO_DATE_TIME

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

ISO_INSTANT

public static final CalendarFormat ISO_INSTANT

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

ISO_LOCAL_DATE

public static final CalendarFormat ISO_LOCAL_DATE

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

ISO_LOCAL_DATE_TIME

public static final CalendarFormat ISO_LOCAL_DATE_TIME

DateTimeFormatter.ISO_LOCAL_DATE_TIME: "2011-12-03T10:15:30".

ISO_LOCAL_TIME

public static final CalendarFormat ISO_LOCAL_TIME

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

ISO_OFFSET_DATE

public static final CalendarFormat ISO_OFFSET_DATE

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

ISO_OFFSET_DATE_TIME

public static final CalendarFormat ISO_OFFSET_DATE_TIME

DateTimeFormatter.ISO_OFFSET_DATE_TIME (the default): "2011-12-03T10:15:30+01:00".

ISO_OFFSET_TIME

public static final CalendarFormat ISO_OFFSET_TIME

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

ISO_ORDINAL_DATE

public static final CalendarFormat ISO_ORDINAL_DATE

DateTimeFormatter.ISO_ORDINAL_DATE: "2012-337".

ISO_TIME

public static final CalendarFormat ISO_TIME

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

ISO_WEEK_DATE

public static final CalendarFormat ISO_WEEK_DATE

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

ISO_ZONED_DATE_TIME

public static final CalendarFormat 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 CalendarFormat RFC_1123_DATE_TIME

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

MILLIS

public static final CalendarFormat 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.

XML_FORMAT

public static final CalendarFormat XML_FORMAT

XML Schema dateTime form.

Lets regular Calendar / GregorianCalendar fields opt into the same wire form that XMLGregorianCalendar fields always use, for symmetry across mixed-type beans.

Method Details

values

public static CalendarFormat[] 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 CalendarFormat 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(Calendar 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 for time-only / unzoned values.

Returns:

The formatted string, or null if value is null.

parse

public Calendar 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 Calendar, 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.

zuluZone

public static ZoneId zuluZone()

Returns the ZoneId used by the ISO_INSTANT variant.

Returns:

The fixed "Z" (UTC) zone id used by the ISO_INSTANT variant.