Package org.cyclos.impl.utils.notifications

Enum NotificationDateFormat

java.lang.Object

java.lang.Enum<NotificationDateFormat>

org.cyclos.impl.utils.notifications.NotificationDateFormat

All Implemented Interfaces:

Serializable, Comparable<NotificationDateFormat>

public enum NotificationDateFormat
extends Enum<NotificationDateFormat>

Used in conjunction with DateFormat to specify the pattern used to format a parameter of type Date in a notification.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DATE	Format the date parameter using only the date part.
DATE_DIFF	If the difference in days between now and the given date parameter is less than 1 then it is the same as DATE_TIME.
DATE_TIME	Format the date parameter using the full date (with time info).

Method Summary

Modifier and Type	Method	Description
static NotificationDateFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NotificationDateFormat[]	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

DATE

public static final NotificationDateFormat DATE

Format the date parameter using only the date part.

DATE_TIME

public static final NotificationDateFormat DATE_TIME

Format the date parameter using the full date (with time info).

DATE_DIFF

public static final NotificationDateFormat DATE_DIFF

If the difference in days between now and the given date parameter is less than 1 then it is the same as DATE_TIME. Otherwise it is the same as DATE plus the difference in days.

Method Detail

values

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

Returns:

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

valueOf

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