Package com.alachisoft.ncache.runtime.caching.messaging

Enum TopicPriority

java.lang.Object

java.lang.Enum<TopicPriority>

com.alachisoft.ncache.runtime.caching.messaging.TopicPriority

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

Specifies the relative priority of topics stored in the cache.

Enum Constant Summary

Enum Constants

Enum Constant	Description
High	Messages in topic with this priority level are less likely to be deleted from the cache as the server frees system memory.
Low	Messages in topic with this priority level are the most likely to be deleted from the cache as the server frees system memory.
Normal	Messages in topic with this priority level are likely to be deleted from the cache as the server frees system memory only after those topics with Low priority.

Method Summary

Modifier and Type	Method	Description
static TopicPriority	forValue(int value)	Retreives the enum constant of the specified value, if exists.
int	getValue()	Order is important in enums.
static TopicPriority	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static TopicPriority[]	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

Low

public static final TopicPriority Low

Messages in topic with this priority level are the most likely to be deleted from the cache as the server frees system memory.

Normal

public static final TopicPriority Normal

Messages in topic with this priority level are likely to be deleted from the cache as the server frees system memory only after those topics with Low priority. This is the default priority of the topic.

High

public static final TopicPriority High

Messages in topic with this priority level are less likely to be deleted from the cache as the server frees system memory.

Method Detail

values

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

Returns:

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

valueOf

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

Order is important in enums. By using getValue() method, each enum constant index can be found, just like array index.

Returns:

Enum constant index.

forValue

public static TopicPriority forValue(int value)

Retreives the enum constant of the specified value, if exists.

Parameters:

value - Enum constant index.

Returns:

Enum constant.