com.scaleout.client.caching

Enum PreemptionPriority

java.lang.Object

java.lang.Enum<PreemptionPriority>

com.scaleout.client.caching.PreemptionPriority

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PreemptionPriority>

public enum PreemptionPriority
extends java.lang.Enum<PreemptionPriority>

The PreemptionPriority enum is used to indicate the priority of keeping a given object in the ScaleOut in-memory data grid under low-memory conditions.

Removable objects are removed from memory when memory runs low based on a least recently used (LRU) algorithm.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Normal The object is a candidate for removal from StateServer memory if memory pressure warrants
NotRemovable The associated object must remain in memory until its expiration is reached or the object is explicitly removed.

Method Summary

Modifier and Type	Method and Description
static PreemptionPriority	fromString(java.lang.String value) Retrieve a PreemptionPriority from a string.
byte	get() Retrieve the byte value of this enum.
static PreemptionPriority	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PreemptionPriority[]	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

NotRemovable

public static final PreemptionPriority NotRemovable

The associated object must remain in memory until its expiration is reached or the object is explicitly removed.

Normal

public static final PreemptionPriority Normal

The object is a candidate for removal from StateServer memory if memory pressure warrants

Method Detail

values

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

Returns:

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

valueOf

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

get

public byte get()

Retrieve the byte value of this enum.

Returns:

the byte value of this enum.

fromString

public static PreemptionPriority fromString(java.lang.String value)

Retrieve a PreemptionPriority from a string. Accepted values: Constants.MEMORY_PREEMPTION_PRIORITY_NORMAL Constants.MEMORY_PREEMPTION_PRIORITY_NOTREMOVABLE

Parameters:

value - Constants.MEMORY_PREEMPTION_PRIORITY_NORMAL, or Constants.MEMORY_PREEMPTION_PRIORITY_NOTREMOVABLE

Returns:

the PreemptionPriority that maps to the parameter string value.