Package org.silverpeas.core.notification.user.delayed.constant

Enum DelayedNotificationFrequency

java.lang.Object

java.lang.Enum<DelayedNotificationFrequency>

org.silverpeas.core.notification.user.delayed.constant.DelayedNotificationFrequency

All Implemented Interfaces:

Serializable, Comparable<DelayedNotificationFrequency>

public enum DelayedNotificationFrequency
extends Enum<DelayedNotificationFrequency>

The different recurrence rule for a delayed notification. It is used for a users having chosen to be notified regularly at once instead of at each notification sent.

Author:

Yohann Chastagnier

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAILY
MONTHLY
NONE
WEEKLY

Method Summary

Modifier and Type	Method	Description
static DelayedNotificationFrequency	decode(String code)
String	getCode()
String	getName()
static Collection<String>	toCodes(Collection<DelayedNotificationFrequency> delayedNotificationFrequencies)	Transforming the given collection into a collection of code, each of them representing a frequency..
String	toString()
static DelayedNotificationFrequency	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DelayedNotificationFrequency[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final DelayedNotificationFrequency NONE

DAILY

public static final DelayedNotificationFrequency DAILY

WEEKLY

public static final DelayedNotificationFrequency WEEKLY

MONTHLY

public static final DelayedNotificationFrequency MONTHLY

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public String getCode()

getName

public String getName()

toString

public String toString()

Overrides:

toString in class Enum<DelayedNotificationFrequency>

decode

public static DelayedNotificationFrequency decode(String code)

toCodes

public static Collection<String> toCodes(Collection<DelayedNotificationFrequency> delayedNotificationFrequencies)

Transforming the given collection into a collection of code, each of them representing a frequency..

Parameters:

delayedNotificationFrequencies - the different frequencies to encode in String.

Returns:

a collection of a string representation of the specified frequencies.