org.xwiki.notifications.filters

Enum NotificationFilter.FilterPolicy

java.lang.Object

java.lang.Enum<NotificationFilter.FilterPolicy>

org.xwiki.notifications.filters.NotificationFilter.FilterPolicy

All Implemented Interfaces:

Serializable, Comparable<NotificationFilter.FilterPolicy>

Enclosing interface:

NotificationFilter

public static enum NotificationFilter.FilterPolicy
extends Enum<NotificationFilter.FilterPolicy>

The different behaviours a filter could have regarding an event.

Since:

9.11.5, 10.3

Enum Constant Summary

Enum Constants

Enum Constant and Description
FILTER Value used when the event must be not returned.
KEEP Value used when the event must be kept.
NO_EFFECT Value used when the filter has no impact on the given event.

Method Summary

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

FILTER

public static final NotificationFilter.FilterPolicy FILTER

Value used when the event must be not returned.

KEEP

public static final NotificationFilter.FilterPolicy KEEP

Value used when the event must be kept.

NO_EFFECT

public static final NotificationFilter.FilterPolicy NO_EFFECT

Value used when the filter has no impact on the given event.

Method Detail

values

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

Returns:

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

valueOf

public static NotificationFilter.FilterPolicy 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