org.infinispan.client.hotrod

Enum Flag

java.lang.Object

java.lang.Enum<Flag>

org.infinispan.client.hotrod.Flag

All Implemented Interfaces:

Serializable, Comparable<Flag>

public enum Flag
extends Enum<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

Since:

4.1

Author:

Mircea.Markus@jboss.com

Enum Constant Summary

Enum Constants

Enum Constant and 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.

Method Summary

Methods

Modifier and Type	Method and Description
int	getFlagInt()
static Flag	valueOf(String name) Returns the enum constant of this type with the specified name.
static Flag[]	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

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

Method Detail

values

public static Flag[] 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 (Flag c : Flag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Flag 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()