org.xwiki.eventstream

Enum RecordableEventDescriptor.EventFilter

java.lang.Object

java.lang.Enum<RecordableEventDescriptor.EventFilter>

org.xwiki.eventstream.RecordableEventDescriptor.EventFilter

All Implemented Interfaces:

Serializable, Comparable<RecordableEventDescriptor.EventFilter>

Enclosing interface:

RecordableEventDescriptor

public static enum RecordableEventDescriptor.EventFilter
extends Enum<RecordableEventDescriptor.EventFilter>

The different filters we support to retrieve event.

Since:

9.4RC1

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM_FILTER There is a custom filter on this kind of events.
NO_FILTER There is no filter (except the event type) on this kind of events.
WIKI_AND_SPACE_FILTER There is a filter to enable the event on some wikis and some spaces.
WIKI_FILTER There is a filter to enable the event on some wikis.
WIKI_SPACE_AND_DOCUMENT_FILTER There is a filter to enable the event on some wikis, some spaces and/or some pages.

Method Summary

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

NO_FILTER

public static final RecordableEventDescriptor.EventFilter NO_FILTER

There is no filter (except the event type) on this kind of events.

CUSTOM_FILTER

public static final RecordableEventDescriptor.EventFilter CUSTOM_FILTER

There is a custom filter on this kind of events.

WIKI_FILTER

public static final RecordableEventDescriptor.EventFilter WIKI_FILTER

There is a filter to enable the event on some wikis.

WIKI_AND_SPACE_FILTER

public static final RecordableEventDescriptor.EventFilter WIKI_AND_SPACE_FILTER

There is a filter to enable the event on some wikis and some spaces.

WIKI_SPACE_AND_DOCUMENT_FILTER

public static final RecordableEventDescriptor.EventFilter WIKI_SPACE_AND_DOCUMENT_FILTER

There is a filter to enable the event on some wikis, some spaces and/or some pages.

Method Detail

values

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

Returns:

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

valueOf

public static RecordableEventDescriptor.EventFilter 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