Package uk.co.sculptor.kflibjava

Enum Class KeyedFile.LockMode

java.lang.Object

java.lang.Enum<KeyedFile.LockMode>

uk.co.sculptor.kflibjava.KeyedFile.LockMode

All Implemented Interfaces:

Serializable, Comparable<KeyedFile.LockMode>, Constable

Enclosing class:

KeyedFile

public static enum KeyedFile.LockMode
extends Enum<KeyedFile.LockMode>

KeyedFile lock mode enumerator.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	No lock
RDLCK	Read lock
TWLCK	Transaction Write lock
UNLCK	Unlock
WRLCK	Write lock

Method Summary

Modifier and Type	Method	Description
byte	getByte()	Returns the KeyedFile lock mode as the byte value used on KfServer
static KeyedFile.LockMode	getFromByte(byte lockMode)	Convert a received value to a LockMode enumerator
static KeyedFile.LockMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KeyedFile.LockMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final KeyedFile.LockMode NONE

No lock

RDLCK

public static final KeyedFile.LockMode RDLCK

Read lock

WRLCK

public static final KeyedFile.LockMode WRLCK

Write lock

UNLCK

public static final KeyedFile.LockMode UNLCK

Unlock

TWLCK

public static final KeyedFile.LockMode TWLCK

Transaction Write lock

Method Details

values

public static KeyedFile.LockMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static KeyedFile.LockMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getFromByte

public static KeyedFile.LockMode getFromByte(byte lockMode)
                                      throws KfException

Convert a received value to a LockMode enumerator

Parameters:

lockMode - The Sculptor value to be translated to enumerator

Returns:

The enumerator value

Throws:

KfException - when the lckMode value is invalid

getByte

public byte getByte()

Returns the KeyedFile lock mode as the byte value used on KfServer

Returns:

KeyedFile lock mode as the byte value used on KfServer