com.scaleoutsoftware.soss.client

Enum ObjectPreemptionPriority

java.lang.Object

java.lang.Enum<ObjectPreemptionPriority>

com.scaleoutsoftware.soss.client.ObjectPreemptionPriority

All Implemented Interfaces:

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

public enum ObjectPreemptionPriority
extends java.lang.Enum<ObjectPreemptionPriority>
implements java.io.Serializable

Indicates the priority of keeping a given object in StateServer memory. Currently, only two priorities are defined, NotRemovable and Normal. Removable objects are removed from memory when memory runs low based on a least recently used algorithm.

Enum Constant Summary

Enum Constants

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

Method Summary

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

Normal

public static final ObjectPreemptionPriority Normal

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

NotRemovable

public static final ObjectPreemptionPriority NotRemovable

The associated object must remain in memory until its absolute or sliding expiration is reached.

Method Detail

values

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

Returns:

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

valueOf

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