Module org.refcodes.time

Package org.refcodes.time

Enum DateFormats

java.lang.Object

java.lang.Enum<DateFormats>

org.refcodes.time.DateFormats

All Implemented Interfaces:

Serializable, Comparable<DateFormats>

public enum DateFormats
extends Enum<DateFormats>

The DateFormats represent sets of DateFormat definitions. Such a set is most useful to parse back a String into a Date when there are multiple possible String representations. E.g. a cookie's date representation might be either as defined by the DateFormat.NETSCAPE_COOKIE_DATE_FORMAT or by the DateFormat.ALTERNATE_COOKIE_DATE_FORMAT.

Enum Constant Summary

Enum Constants

Enum Constant	Description
COOKIE_DATE_FORMATS	Set of DateFormat definitions commonly used by cookies.
DEFAULT_DATE_FORMATS	Sound set of common DateFormat definitions with no special addressee.
DEFAULT_DATE_FORMATS_SHORT	Sound set of common short DateFormat definitions with no special addressee.
INTERNET_DATE_FORMATS	Set of DateFormat definitions found in heterogeneous internet related services.
ISO_DATE_FORMATS	Set of common DateFormat ISO definitions.

Method Summary

Modifier and Type	Method	Description
static Date	asDate(String aDateString)	Tries to create a Date by harnessing the DateTimeFormatter instances known by this enumeration.
static LocalDate	asLocalDate(String aDateString)	Tries to create a LocalDate by harnessing the DateTimeFormatter instances known by this enumeration.
static LocalDateTime	asLocalDateTime(String aDateString)	Tries to create a LocalDateTime by harnessing the DateTimeFormatter instances known by this enumeration.
DateTimeFormatter[]	getDateFormats()	Gets the date formats.
Date	toDate(String aDateString)	Creates a Date from the provided String using the date formats as retrieved by the getDateFormats() method.
LocalDate	toLocalDate(String aDateString)	Creates a LocalDate from the provided String using the date formats as retrieved by the getDateFormats() method.
LocalDateTime	toLocalDateTime(String aDateString)	Creates a LocalDateTime from the provided String using the date formats as retrieved by the getDateFormats() method.
static DateFormats	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DateFormats[]	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

DEFAULT_DATE_FORMATS

public static final DateFormats DEFAULT_DATE_FORMATS

Sound set of common DateFormat definitions with no special addressee.

DEFAULT_DATE_FORMATS_SHORT

public static final DateFormats DEFAULT_DATE_FORMATS_SHORT

Sound set of common short DateFormat definitions with no special addressee.

COOKIE_DATE_FORMATS

public static final DateFormats COOKIE_DATE_FORMATS

Set of DateFormat definitions commonly used by cookies.

INTERNET_DATE_FORMATS

public static final DateFormats INTERNET_DATE_FORMATS

Set of DateFormat definitions found in heterogeneous internet related services.

ISO_DATE_FORMATS

public static final DateFormats ISO_DATE_FORMATS

Set of common DateFormat ISO definitions.

Method Detail

values

public static DateFormats[] 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 (DateFormats c : DateFormats.values())
    System.out.println(c);

Returns:

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

valueOf

public static DateFormats 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

getDateFormats

public DateTimeFormatter[] getDateFormats()

Gets the date formats.

Returns:

the date formats

toDate

public Date toDate(String aDateString)
            throws DateTimeException

Creates a Date from the provided String using the date formats as retrieved by the getDateFormats() method. If one date format fails, then the next one is used to parse the date text.

Parameters:

aDateString - The date text to be converted to a Date instance.

Returns:

The Date instance as of the date text.

Throws:

DateTimeException - Thrown in case none of the provided DateTimeFormatter instances was able to parse the string. Then the first caught DateTimeException is thrown.

toLocalDate

public LocalDate toLocalDate(String aDateString)
                      throws DateTimeException

Creates a LocalDate from the provided String using the date formats as retrieved by the getDateFormats() method. If one date format fails, then the next one is used to parse the date text.

Parameters:

aDateString - The date text to be converted to a Date instance.

Returns:

The Date instance as of the date text.

Throws:

DateTimeException - Thrown in case none of the provided DateTimeFormatter instances was able to parse the string. Then the first caught DateTimeException is thrown.

toLocalDateTime

public LocalDateTime toLocalDateTime(String aDateString)
                              throws DateTimeException

Creates a LocalDateTime from the provided String using the date formats as retrieved by the getDateFormats() method. If one date format fails, then the next one is used to parse the date text.

Parameters:

aDateString - The date text to be converted to a Date instance.

Returns:

The Date instance as of the date text.

Throws:

DateTimeException - Thrown in case none of the provided DateTimeFormatter instances was able to parse the string. Then the first caught DateTimeException is thrown.

asDate

public static Date asDate(String aDateString)
                   throws DateTimeException

Tries to create a Date by harnessing the DateTimeFormatter instances known by this enumeration.

Parameters:

aDateString - The date text to be converted to a Date instance.

Returns:

The Date instance as of the date text.

Throws:

DateTimeException - Thrown in case none of the provided DateTimeFormatter instances was able to parse the string. Then the first caught DateTimeException is thrown.

asLocalDate

public static LocalDate asLocalDate(String aDateString)
                             throws DateTimeException

Tries to create a LocalDate by harnessing the DateTimeFormatter instances known by this enumeration.

Parameters:

aDateString - The date text to be converted to a LocalDate instance.

Returns:

The LocalDate instance as of the date text.

Throws:

DateTimeException - Thrown in case none of the provided DateTimeFormatter instances was able to parse the string. Then the first caught DateTimeException is thrown.

asLocalDateTime

public static LocalDateTime asLocalDateTime(String aDateString)
                                     throws DateTimeException

Tries to create a LocalDateTime by harnessing the DateTimeFormatter instances known by this enumeration.

Parameters:

aDateString - The date text to be converted to a LocalDate instance.

Returns:

The LocalDateTime instance as of the date text.

Throws:

DateTimeException - Thrown in case none of the provided DateTimeFormatter instances was able to parse the string. Then the first caught DateTimeException is thrown.