Package com.alachisoft.ncache.client

Enum StreamMode

java.lang.Object

java.lang.Enum<StreamMode>

com.alachisoft.ncache.client.StreamMode

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

Represents the modes for opening a cache stream.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Read	Stream read mode without acquiring reader lock.
ReadWithoutLock	Stream read mode by acquiring reader lock.
Write	Stream mode for writing/updating the stream.

Method Summary

Modifier and Type	Method	Description
static StreamMode	forValue(int value)	retreives the enum constant of the specified value, if exists.
int	getValue()	Order is important in enums.By using getValue() method, each enum constant index can be found, just like array index.
static StreamMode	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static StreamMode[]	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

Read

public static final StreamMode Read

Stream read mode without acquiring reader lock.

ReadWithoutLock

public static final StreamMode ReadWithoutLock

Stream read mode by acquiring reader lock.

Write

public static final StreamMode Write

Stream mode for writing/updating the stream. Writer lock should be acquired.

Method Detail

values

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

Returns:

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

valueOf

public static StreamMode 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 StreamMode forValue(int value)

retreives 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