Package org.infinispan.hotrod

Enum HotRodFlag

java.lang.Object
java.lang.Enum<HotRodFlag>
org.infinispan.hotrod.HotRodFlag
All Implemented Interfaces:
Serializable, Comparable<HotRodFlag>, org.infinispan.api.common.Flag
public enum HotRodFlag extends Enum<HotRodFlag> implements org.infinispan.api.common.Flag
Defines all the flags available in the Hot Rod client that can influence the behavior of operations.

Available flags:

  • DEFAULT_LIFESPAN This flag can either be used as a request flag during a put operation to mean that the default server lifespan should be applied or as a response flag meaning that the return entry has a default lifespan value
  • DEFAULT_MAXIDLE This flag can either be used as a request flag during a put operation to mean that the default server maxIdle should be applied or as a response flag meaning that the return entry has a default maxIdle value
  • SKIP_CACHE_LOAD Skips loading an entry from any configured cache loaders
  • SKIP_INDEXING Used by the Query module only, it will prevent the indexes to be updated as a result of the current operations.
  • SKIP_LISTENER_NOTIFICATION Used when an operation wants to skip notifications to the registered listeners
Since:
14.0

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DEFAULT_LIFESPAN
    This flag can either be used as a request flag during a put operation to mean that the default server lifespan should be applied or as a response flag meaning that the return entry has a default lifespan value
    DEFAULT_MAXIDLE
    This flag can either be used as a request flag during a put operation to mean that the default server maxIdle should be applied or as a response flag meaning that the return entry has a default maxIdle value
    SKIP_CACHE_LOAD
    Skips loading an entry from any configured cache loaders
    SKIP_INDEXING
    Used by the Query module only, it will prevent the indexes to be updated as a result of the current operations.
    SKIP_LISTENER_NOTIFICATION
    It will skip client listeners to be notified.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.infinispan.api.common.Flags<?,?>
    add(org.infinispan.api.common.Flags<?,?> flags)
     
    int
    getFlagInt()
     
    static HotRodFlag
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static HotRodFlag[]
    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 Details

    • DEFAULT_LIFESPAN

      public static final HotRodFlag DEFAULT_LIFESPAN
      This flag can either be used as a request flag during a put operation to mean that the default server lifespan should be applied or as a response flag meaning that the return entry has a default lifespan value

    • DEFAULT_MAXIDLE

      public static final HotRodFlag DEFAULT_MAXIDLE
      This flag can either be used as a request flag during a put operation to mean that the default server maxIdle should be applied or as a response flag meaning that the return entry has a default maxIdle value

    • SKIP_CACHE_LOAD

      public static final HotRodFlag SKIP_CACHE_LOAD
      Skips loading an entry from any configured cache loaders

    • SKIP_INDEXING

      public static final HotRodFlag SKIP_INDEXING
      Used by the Query module only, it will prevent the indexes to be updated as a result of the current operations.

    • SKIP_LISTENER_NOTIFICATION

      public static final HotRodFlag SKIP_LISTENER_NOTIFICATION
      It will skip client listeners to be notified.

  • Method Details

    • values

      public static HotRodFlag[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

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

    • getFlagInt

      public int getFlagInt()

    • add

      public org.infinispan.api.common.Flags<?,?> add(org.infinispan.api.common.Flags<?,?> flags)
      Specified by:
      add in interface org.infinispan.api.common.Flag