Package org.exoplatform.commons.api.settings.data

Enum Class EventType

java.lang.Object

java.lang.Enum<EventType>

org.exoplatform.commons.api.settings.data.EventType

All Implemented Interfaces:

Serializable, Comparable<EventType>, Constable

public enum EventType
extends Enum<EventType>

All possible value types of an event.

eXo level API

Experimental

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SETTING_REMOVE_CONTEXT	Type of the dispatched event when all setting properties are removed from a context (GLOBAL/USER context).
SETTING_REMOVE_KEY	Type of the dispatched event when a setting property is removed.
SETTING_REMOVE_SCOPE	Type of the dispatched event when all setting properties are removed from a specified scope.
SETTING_SET	Type of the dispatched event when a setting property is saved successfully.

Method Summary

Modifier and Type	Method	Description
static EventType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EventType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SETTING_SET

public static final EventType SETTING_SET

Type of the dispatched event when a setting property is saved successfully.

eXo level API

Experimental

SETTING_REMOVE_CONTEXT

public static final EventType SETTING_REMOVE_CONTEXT

Type of the dispatched event when all setting properties are removed from a context (GLOBAL/USER context).

eXo level API

Experimental

SETTING_REMOVE_SCOPE

public static final EventType SETTING_REMOVE_SCOPE

Type of the dispatched event when all setting properties are removed from a specified scope.

eXo level API

Experimental

SETTING_REMOVE_KEY

public static final EventType SETTING_REMOVE_KEY

Type of the dispatched event when a setting property is removed.

eXo level API

Experimental

Method Details

values

public static EventType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EventType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null