ezvcard.util

Enum VCardDateFormat

java.lang.Object

java.lang.Enum<VCardDateFormat>

ezvcard.util.VCardDateFormat

All Implemented Interfaces:

Serializable, Comparable<VCardDateFormat>

public enum VCardDateFormat
extends Enum<VCardDateFormat>

Parses and formats vCard timestamp values. These date formats are defined in the ISO8601 specification.

Author:

Michael Angstadt

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASIC Formats dates using "basic" format.
EXTENDED Formats dates using "extended" format.

Method Summary

Modifier and Type	Method and Description
String	format(TemporalAccessor temporalAccessor) Formats a date (also accepts ZoneOffset).
static boolean	hasTime(TemporalAccessor temporalAccessor) Determines if the given date has a time component
static Temporal	parse(String string) Parses a date string.
static VCardDateFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static VCardDateFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXTENDED

public static final VCardDateFormat EXTENDED

Formats dates using "extended" format. In this format, dashes separate the date components, and colons separate the time components.

Examples:

• 2012-07-01 (LocalDate)
• 2012-07-01T14:21:10 (LocalDateTime)
• 2012-07-01T14:21:10-05:00 (OffsetDateTime)
• 2012-07-01T14:21:10Z (Instant)

BASIC

public static final VCardDateFormat BASIC

Formats dates using "basic" format. In this format, nothing separates the date and time components from each other.

Examples:

• 20120701 (LocalDate)
• 20120701T142110 (LocalDateTime)
• 20120701T142110-0500 (OffsetDateTime)
• 20120701T142110Z (Instant)

Method Detail

values

public static VCardDateFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VCardDateFormat c : VCardDateFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static VCardDateFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

format

public String format(TemporalAccessor temporalAccessor)

Formats a date (also accepts ZoneOffset).

Parameters:

temporalAccessor - the date

Returns:

the formatted date

parse

public static Temporal parse(String string)

Parses a date string. String can be in basic or extended formats.

Examples:

• "2012-07-01" returns LocalDate
• "2012-07-01T14:21:10" returns LocalDateTime
• "2012-07-01T14:21:10-05:00" returns OffsetDateTime
• "2012-07-01T14:21:10Z" returns Instant

Parameters:

string - the string to parse

Returns:

the parsed date

Throws:

IllegalArgumentException - if the date string isn't in one of the accepted ISO8601 formats or if it contains an invalid value (e.g. "13" for the month)

hasTime

public static boolean hasTime(TemporalAccessor temporalAccessor)

Determines if the given date has a time component

Parameters:

temporalAccessor - the date

Returns:

true if it has a time component, false if not