Package org.xwiki.notifications.preferences

Enum NotificationPreferenceProperty

java.lang.Object

java.lang.Enum<NotificationPreferenceProperty>

org.xwiki.notifications.preferences.NotificationPreferenceProperty

All Implemented Interfaces:

Serializable, Comparable<NotificationPreferenceProperty>

public enum NotificationPreferenceProperty
extends Enum<NotificationPreferenceProperty>

Possible properties that can be bound to a notification in order to characterize it.

Since:

9.7RC1

Version:

$Id: dc7a1f0e6fdf38b1cf03d53e969551b9cc4914b9 $

Enum Constant Summary

Enum Constants

Enum Constant	Description
EVENT_TYPE	The type of the event linked to the notification.

Method Summary

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

EVENT_TYPE

public static final NotificationPreferenceProperty EVENT_TYPE

The type of the event linked to the notification.

Method Detail

values

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

Returns:

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

valueOf

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