com.scaleoutsoftware.soss.client.map

Enum ReturnBehavior

java.lang.Object

java.lang.Enum<ReturnBehavior>

com.scaleoutsoftware.soss.client.map.ReturnBehavior

All Implemented Interfaces:

Serializable, Comparable<ReturnBehavior>

public enum ReturnBehavior
extends Enum<ReturnBehavior>

This enum defines whether NamedMap.put(Object, Object) and NamedMap.remove(Object) methods should return the previous value associated with the key. Returning the previous value of the key requires reading the map from the data grid. For optimal performance when the previous value is not required, set the ReturnBehavior to RETURN_NULL. The enum member is passed to NamedMap.setReturnBehavior(ReturnBehavior) By default, return behavior is always null (RETURN_NULL).

Enum Constant Summary

Enum Constants

Enum Constant and Description
RETURN_NULL NamedMap.put(Object, Object) and NamedMap.remove(Object) always return null.
STANDARD NamedMap.put(Object, Object) and NamedMap.remove(Object) will return the previous value, as specified in Map.

Method Summary

Modifier and Type	Method and Description
static ReturnBehavior	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReturnBehavior[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RETURN_NULL

public static final ReturnBehavior RETURN_NULL

NamedMap.put(Object, Object) and NamedMap.remove(Object) always return null. This setting should be used to achieve best performance when the previous values are not needed. This is the default setting.

STANDARD

public static final ReturnBehavior STANDARD

NamedMap.put(Object, Object) and NamedMap.remove(Object) will return the previous value, as specified in Map. This setting should only be applied if the returned values are intended to be used, since RETURN_NULL provides better performance.

Method Detail

values

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

Returns:

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

valueOf

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