Package com.alachisoft.ncache.runtime.caching

Enum SubscriptionPolicy

java.lang.Object

java.lang.Enum<SubscriptionPolicy>

com.alachisoft.ncache.runtime.caching.SubscriptionPolicy

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

Defines the policy used in case of Durable subscription.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Exclusive	Exclusive subscription policy is for a single subscriber on a single subscription.
Shared	Shared subscription policy is for multiple subscribers on a single subscription.

Method Summary

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

Shared

public static final SubscriptionPolicy Shared

Shared subscription policy is for multiple subscribers on a single subscription. In this case, messages are sent to any of the topic subscribers. This policy provides better load division over clients subscribing to a subscription.

Exclusive

public static final SubscriptionPolicy Exclusive

Exclusive subscription policy is for a single subscriber on a single subscription. In this case, messages are recieved by the single subscriber only.

Method Detail

values

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

Returns:

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

valueOf

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

forValue

public static SubscriptionPolicy forValue(int value)

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

Parameters:

value - Enum constant index.

Returns:

Enum constant.

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.