Package org.xwiki.notifications.preferences

Enum NotificationEmailInterval

java.lang.Object

java.lang.Enum<NotificationEmailInterval>

org.xwiki.notifications.preferences.NotificationEmailInterval

All Implemented Interfaces:

Serializable, Comparable<NotificationEmailInterval>

public enum NotificationEmailInterval
extends Enum<NotificationEmailInterval>

Several intervals to get notified by emails.

Since:

12.6

Version:

$Id: 5509ea3ee97a67f7a0e26c99580e6ff2711e74f4 $

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAILY	Receive a mail every day (if needed).
HOURLY	Receive a mail every hour (if needed).
LIVE	Receive an e-mail when a notification is triggered in the wiki.
WEEKLY	Receive a mail every week (if needed).

Method Summary

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

HOURLY

public static final NotificationEmailInterval HOURLY

Receive a mail every hour (if needed).

DAILY

public static final NotificationEmailInterval DAILY

Receive a mail every day (if needed).

WEEKLY

public static final NotificationEmailInterval WEEKLY

Receive a mail every week (if needed).

LIVE

public static final NotificationEmailInterval LIVE

Receive an e-mail when a notification is triggered in the wiki.

Since:

9.6RC1

Method Detail

values

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

Returns:

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

valueOf

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