Package org.infinispan.counter.api

Enum Class CounterState

java.lang.Object

java.lang.Enum<CounterState>

org.infinispan.counter.api.CounterState

All Implemented Interfaces:

Serializable, Comparable<CounterState>, Constable

@ProtoTypeId(4000)
public enum CounterState
extends Enum<CounterState>

The possible states for a counter value.

Since:

9.0

Author:

Pedro Ruivo

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
LOWER_BOUND_REACHED	The counter value has reached its min threshold, i.e.
UPPER_BOUND_REACHED	The counter value has reached its max threshold.
VALID	The counter value is valid.

Method Summary

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

VALID

@ProtoEnumValue(number=0)
public static final CounterState VALID

The counter value is valid.

LOWER_BOUND_REACHED

@ProtoEnumValue(number=1)
public static final CounterState LOWER_BOUND_REACHED

The counter value has reached its min threshold, i.e. no thresholds has been reached.

UPPER_BOUND_REACHED

@ProtoEnumValue(number=2)
public static final CounterState UPPER_BOUND_REACHED

The counter value has reached its max threshold.

Method Details

values

public static CounterState[] 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 CounterState 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

valueOf

public static CounterState valueOf(int index)

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:

index - 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