org.xwiki.notifications.filters

Enum NotificationFilterType

java.lang.Object

java.lang.Enum<NotificationFilterType>

org.xwiki.notifications.filters.NotificationFilterType

All Implemented Interfaces:

Serializable, Comparable<NotificationFilterType>

public enum NotificationFilterType
extends Enum<NotificationFilterType>

Determine the filter type of an NotificationFilter. This type can be either inclusive or exclusive.

Since:

9.7RC1

Version:

$Id: 3522fb0cc7cbdc00f1c5e83ceec470e543dd6a02 $

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCLUSIVE The filter associated with this scope type be exclusive.
INCLUSIVE This is the default type, the filter associated with this type will be inclusive.

Method Summary

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

INCLUSIVE

public static final NotificationFilterType INCLUSIVE

This is the default type, the filter associated with this type will be inclusive.

EXCLUSIVE

public static final NotificationFilterType EXCLUSIVE

The filter associated with this scope type be exclusive.

Method Detail

values

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

Returns:

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

valueOf

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