Package org.infinispan.counter.api

Enum CounterState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CounterState>
    @ProtoTypeId(4000)
public enum CounterState
extends java.lang.Enum<CounterState>
    The possible states for a counter value.
    Since:
    9.0
    Author:
    Pedro Ruivo

    • 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static CounterState valueOf​(int index)
      Returns the enum constant of this type with the specified name.
      static CounterState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CounterState[] 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

      • 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 Detail

      • values

        public static CounterState[] 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 (CounterState c : CounterState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static CounterState valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • valueOf

        public static CounterState 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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null