Package org.xwiki.notifications.filters.expression

Enum EventProperty

java.lang.Object

java.lang.Enum<EventProperty>

org.xwiki.notifications.filters.expression.EventProperty

All Implemented Interfaces:

Serializable, Comparable<EventProperty>

public enum EventProperty
extends Enum<EventProperty>

The several properties you can have in an Event.

Since:

9.8RC1

Version:

$Id: 61b9408d269c44afb1bb29febcd4ea5798534311 $

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPLICATION	The application the event belongs to.
BODY	The content of the event.
DATE	The date of the event.
DOCUMENT_VERSION	The version of the page concerned by the event.
GROUP_ID	The group ID of the event.
HIDDEN	Either of the event is hidden or not.
ID	The ID of the event.
IMPORTANCE	The importance of the event.
PAGE	The page concerned by the event.
REMOTE_OBSERVATION_ID	The unique identifier of the instance in the cluster.
SPACE	The space concerned by the event.
STREAM	The stream the event belongs to.
TITLE	The title of the page concerned by the event.
TYPE	The type of the event.
URL	The URL of the page concerned by the event.
USER	The user who created the event.
WIKI	The wiki concerned by the event.

Method Summary

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

ID

public static final EventProperty ID

The ID of the event.

GROUP_ID

public static final EventProperty GROUP_ID

The group ID of the event.

STREAM

public static final EventProperty STREAM

The stream the event belongs to.

DATE

public static final EventProperty DATE

The date of the event.

IMPORTANCE

public static final EventProperty IMPORTANCE

The importance of the event.

TYPE

public static final EventProperty TYPE

The type of the event.

APPLICATION

public static final EventProperty APPLICATION

The application the event belongs to.

USER

public static final EventProperty USER

The user who created the event.

WIKI

public static final EventProperty WIKI

The wiki concerned by the event.

SPACE

public static final EventProperty SPACE

The space concerned by the event.

PAGE

public static final EventProperty PAGE

The page concerned by the event.

HIDDEN

public static final EventProperty HIDDEN

Either of the event is hidden or not.

URL

public static final EventProperty URL

The URL of the page concerned by the event.

TITLE

public static final EventProperty TITLE

The title of the page concerned by the event.

BODY

public static final EventProperty BODY

The content of the event.

DOCUMENT_VERSION

public static final EventProperty DOCUMENT_VERSION

The version of the page concerned by the event.

REMOTE_OBSERVATION_ID

@Unstable
public static final EventProperty REMOTE_OBSERVATION_ID

The unique identifier of the instance in the cluster.

Since:

14.7RC1

Method Detail

values

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

Returns:

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

valueOf

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