com.scaleout.client.caching.query

Enum HashIndexPriority

java.lang.Object

java.lang.Enum<HashIndexPriority>

com.scaleout.client.caching.query.HashIndexPriority

All Implemented Interfaces:

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

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

This enum allows sorting of hashed attributes by priority. All hashed attributes are sorted by priority and the top NUM_CACHED_ATTRIBUTES of them are actually hashed in the server.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Hashable The item the CacheObjectAttribute refers to will be entered into the in-memory datagrid hashtable if there's room after attempting to hash all higher priority items.
HighPriorityHashable The item the CacheObjectAttribute refers to will be entered into the StateServer Hashtable if there's room.
NotHashable The item in the CacheObjectAttribute refers to is never entered into the StateServer Hashtable.

Method Summary

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

NotHashable

public static final HashIndexPriority NotHashable

The item in the CacheObjectAttribute refers to is never entered into the StateServer Hashtable.

Hashable

public static final HashIndexPriority Hashable

The item the CacheObjectAttribute refers to will be entered into the in-memory datagrid hashtable if there's room after attempting to hash all higher priority items.

HighPriorityHashable

public static final HashIndexPriority HighPriorityHashable

The item the CacheObjectAttribute refers to will be entered into the StateServer Hashtable if there's room. Items with this priority will take precedence over any items marked Hashable.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Retrieves the value for this enum.

Returns:

the value.