org.xwiki.notifications.filters

Enum NotificationFilterProperty

java.lang.Object

java.lang.Enum<NotificationFilterProperty>

org.xwiki.notifications.filters.NotificationFilterProperty

All Implemented Interfaces:

Serializable, Comparable<NotificationFilterProperty>

public enum NotificationFilterProperty
extends Enum<NotificationFilterProperty>

Define a list of properties supported by PropertyValueNode. Those properties can be used in order to create specific filters on notifications.

Since:

9.7RC1

Version:

$Id: 413cebfae02bc115f90b28a8e24df4fbb154edd4 $

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLICATION The notification application.
BODY The notification body.
EVENT_TYPE The type of event that triggered the notification.
HIDDEN Is the document focused by the notification hidden ?
PAGE Page targeted by the notification.
PRIORITY Priority of the event that triggered the notification.
SPACE The space targeted by the notification.
TITLE The title of the notification.
USER The user targeted by the notification.
WIKI The wiki in which the notification occurred.

Method Summary

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

APPLICATION

public static final NotificationFilterProperty APPLICATION

The notification application.

BODY

public static final NotificationFilterProperty BODY

The notification body.

EVENT_TYPE

public static final NotificationFilterProperty EVENT_TYPE

The type of event that triggered the notification.

HIDDEN

public static final NotificationFilterProperty HIDDEN

Is the document focused by the notification hidden ?

PAGE

public static final NotificationFilterProperty PAGE

Page targeted by the notification.

PRIORITY

public static final NotificationFilterProperty PRIORITY

Priority of the event that triggered the notification.

SPACE

public static final NotificationFilterProperty SPACE

The space targeted by the notification.

TITLE

public static final NotificationFilterProperty TITLE

The title of the notification.

USER

public static final NotificationFilterProperty USER

The user targeted by the notification.

WIKI

public static final NotificationFilterProperty WIKI

The wiki in which the notification occurred.

Method Detail

values

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

Returns:

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

valueOf

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