Package org.infinispan.client.hotrod

Enum Class Flag

java.lang.Object
java.lang.Enum<Flag>
org.infinispan.client.hotrod.Flag
All Implemented Interfaces:
Serializable, Comparable<Flag>, Constable, org.infinispan.api.common.Flag
public enum Flag extends Enum<Flag> 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:

  • FORCE_RETURN_VALUE - By default, previously existing values for Map operations are not returned. E.g. BasicCache.put(Object, Object) does not return the previous value associated with the key. By applying this flag, this default behavior is overridden for the scope of a single invocation, and the previous existing value is returned.
  • 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 CacheLoaders.
  • 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:
4.1
Author:
Mircea.Markus@jboss.com

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • 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
    FORCE_RETURN_VALUE
    By default, previously existing values for Map operations are not returned.
    SKIP_CACHE_LOAD
    Skips loading an entry from any configured CacheLoaders.
    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 Flag
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Flag[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • FORCE_RETURN_VALUE

      public static final Flag FORCE_RETURN_VALUE
      By default, previously existing values for Map operations are not returned. E.g. BasicCache.put(Object, Object) does not return the previous value associated with the key.

      By applying this flag, this default behavior is overridden for the scope of a single invocation, and the previous existing value is returned.

    • DEFAULT_LIFESPAN

      public static final Flag 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 Flag 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 Flag SKIP_CACHE_LOAD
      Skips loading an entry from any configured CacheLoaders.

    • SKIP_INDEXING

      public static final Flag 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 Flag SKIP_LISTENER_NOTIFICATION
      It will skip client listeners to be notified.
      Since:
      9.4.15

  • Method Details

    • values

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

    • valueOf

      public static Flag valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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