Package org.infinispan.counter.api

Enum CounterType

java.lang.Object

java.lang.Enum<CounterType>

org.infinispan.counter.api.CounterType

All Implemented Interfaces:

Serializable, Comparable<CounterType>

public enum CounterType
extends Enum<CounterType>

The counter types.

Since:

9.0

Author:

Pedro Ruivo

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOUNDED_STRONG	A strong consistent and bounded counter.
UNBOUNDED_STRONG	A strong consistent and unbounded counter.
WEAK	A weak consistent counter.

Method Summary

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

UNBOUNDED_STRONG

public static final CounterType UNBOUNDED_STRONG

A strong consistent and unbounded counter. The counter will never throw a CounterOutOfBoundsException.

BOUNDED_STRONG

public static final CounterType BOUNDED_STRONG

A strong consistent and bounded counter. The counter will throw CounterOutOfBoundsException if the boundaries are reached. The upper and lower bound are inclusive.

WEAK

public static final CounterType WEAK

A weak consistent counter. It focus on write performance and its counter value is only calculated at read time.

Method Detail

values

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

Returns:

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

valueOf

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

valueOf

public static CounterType valueOf(int index)

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:

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