org.xwiki.notifications.filters

Enum NotificationFilter.FilteringPhase

java.lang.Object

java.lang.Enum<NotificationFilter.FilteringPhase>

org.xwiki.notifications.filters.NotificationFilter.FilteringPhase

All Implemented Interfaces:

Serializable, Comparable<NotificationFilter.FilteringPhase>

Enclosing interface:

NotificationFilter

@Unstable
public static enum NotificationFilter.FilteringPhase
extends Enum<NotificationFilter.FilteringPhase>

The different phases when a filter can be called.

Since:

12.9RC1, 12.6.3

Enum Constant Summary

Enum Constants

Enum Constant and Description
POST_FILTERING If the filter is used during post-filtering.
PRE_FILTERING If the filter is used during pre-filtering.

Method Summary

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

POST_FILTERING

public static final NotificationFilter.FilteringPhase POST_FILTERING

If the filter is used during post-filtering.

PRE_FILTERING

public static final NotificationFilter.FilteringPhase PRE_FILTERING

If the filter is used during pre-filtering.

Method Detail

values

public static NotificationFilter.FilteringPhase[] 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.FilteringPhase c : NotificationFilter.FilteringPhase.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.FilteringPhase 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