Package org.ehcache.event

Enum EventOrdering

java.lang.Object

java.lang.Enum<EventOrdering>

org.ehcache.event.EventOrdering

All Implemented Interfaces:

Serializable, Comparable<EventOrdering>, java.lang.constant.Constable

public enum EventOrdering
extends Enum<EventOrdering>

The supported event ordering modes.

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
ORDERED	Ordering of events is guaranteed on a per-key basis.
UNORDERED	Events may be observed out of order.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	ordered

Constructor Summary

Constructors

Modifier	Constructor	Description
private	EventOrdering(boolean ordered)

Method Summary

Modifier and Type	Method	Description
boolean	isOrdered()	Indicates if the mode obeys ordering.
static EventOrdering	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EventOrdering[]	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, 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

UNORDERED

public static final EventOrdering UNORDERED

Events may be observed out of order.

ORDERED

public static final EventOrdering ORDERED

Ordering of events is guaranteed on a per-key basis.

Field Details

ordered

private final boolean ordered

Constructor Details

EventOrdering

private EventOrdering(boolean ordered)

Method Details

values

public static EventOrdering[] values()

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

Returns:

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

valueOf

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

isOrdered

public boolean isOrdered()

Indicates if the mode obeys ordering.

Returns:

true in case it does, false otherwise