org.xwiki.notifications.filters.watch

Enum AutomaticWatchMode

java.lang.Object

java.lang.Enum<AutomaticWatchMode>

org.xwiki.notifications.filters.watch.AutomaticWatchMode

All Implemented Interfaces:

Serializable, Comparable<AutomaticWatchMode>

public enum AutomaticWatchMode
extends Enum<AutomaticWatchMode>

Possible ways of automatically watching documents.

Since:

9.8RC1

Version:

$Id: 01b357692f1e79d1fc6f0a9b835e10fa3fb50463 $

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Watch any modified document.
MAJOR Watch any modified document when it's not a minor edit.
NEW Watch any new document.
NONE Disabled.

Method Summary

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

NONE

public static final AutomaticWatchMode NONE

Disabled.

ALL

public static final AutomaticWatchMode ALL

Watch any modified document.

MAJOR

public static final AutomaticWatchMode MAJOR

Watch any modified document when it's not a minor edit.

NEW

public static final AutomaticWatchMode NEW

Watch any new document.

Method Detail

values

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

Returns:

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

valueOf

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