Package org.cyclos.model.system.languages

Enum DateFormat

java.lang.Object

java.lang.Enum<DateFormat>

org.cyclos.model.system.languages.DateFormat

All Implemented Interfaces:

Serializable, Comparable<DateFormat>, HasMessageKey

public enum DateFormat
extends Enum<DateFormat>
implements HasMessageKey

Possible formats for dates

Enum Constant Summary

Enum Constants

Enum Constant	Description
DMY_DASH
DMY_PERIOD
DMY_SLASH
MDY_DASH
MDY_PERIOD
MDY_SLASH
YMD_DASH
YMD_PERIOD
YMD_SLASH

Method Summary

Modifier and Type	Method	Description
String	format(DateTime dateTime)
String	formatRelative(DateTime referenceDateTime, DateTime dateTime)	Formats a dateTime based on a referenceDateTime.
static DateFormat	forOrderAndSeparator(String order, char separator)	Returns the format for the given fields order (which may be "DMY", "MDY" or "YMD") and separator char, or throws IllegalArgumentException if there's no match
MessageKey	getMessageKey()
String	getPattern()
static DateFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DateFormat[]	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

DMY_SLASH

public static final DateFormat DMY_SLASH

DMY_DASH

public static final DateFormat DMY_DASH

DMY_PERIOD

public static final DateFormat DMY_PERIOD

MDY_SLASH

public static final DateFormat MDY_SLASH

MDY_DASH

public static final DateFormat MDY_DASH

MDY_PERIOD

public static final DateFormat MDY_PERIOD

YMD_SLASH

public static final DateFormat YMD_SLASH

YMD_DASH

public static final DateFormat YMD_DASH

YMD_PERIOD

public static final DateFormat YMD_PERIOD

Method Detail

values

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

Returns:

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

valueOf

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

forOrderAndSeparator

public static DateFormat forOrderAndSeparator(String order,
                                              char separator)

Returns the format for the given fields order (which may be "DMY", "MDY" or "YMD") and separator char, or throws IllegalArgumentException if there's no match

format

public String format(DateTime dateTime)

formatRelative

public String formatRelative(DateTime referenceDateTime,
                             DateTime dateTime)

Formats a dateTime based on a referenceDateTime. If the reference date time has the same year as the date time then the year won't be displayed.

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey

getPattern

public String getPattern()