Package com.github.ambry.store

Enum StoreGetOptions

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<StoreGetOptions>
    public enum StoreGetOptions
extends java.lang.Enum<StoreGetOptions>
    The list of options that can be used while reading messages from the store

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Store_Include_Deleted
      This option indicates that the store needs to return the message even if it has been marked for deletion as long as the message has not been physically deleted from the store.
      Store_Include_Expired
      This option indicates that the store needs to return the message even if it is expired as long as the message has not been physically deleted from the store.

    • Method Summary

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

      • Store_Include_Expired

        public static final StoreGetOptions Store_Include_Expired
        This option indicates that the store needs to return the message even if it is expired as long as the message has not been physically deleted from the store.

      • Store_Include_Deleted

        public static final StoreGetOptions Store_Include_Deleted
        This option indicates that the store needs to return the message even if it has been marked for deletion as long as the message has not been physically deleted from the store.

    • Method Detail

      • values

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

      • valueOf

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