Package org.ehcache.event

Enum EventOrdering

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<EventOrdering>
    public enum EventOrdering
extends java.lang.Enum<EventOrdering>
    The supported event ordering modes.

    • 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 boolean ordered  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private EventOrdering​(boolean ordered)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isOrdered()
      Indicates if the mode obeys ordering.
      static EventOrdering valueOf​(java.lang.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

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

      • ordered

        private final boolean ordered

    • Constructor Detail

      • EventOrdering

        private EventOrdering​(boolean ordered)

    • Method Detail

      • values

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

      • valueOf

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

      • isOrdered

        public boolean isOrdered()
        Indicates if the mode obeys ordering.
        Returns:
        true in case it does, false otherwise