Package uk.co.sculptor.kflibjava

Enum Class KeyedFile.Mode

java.lang.Object

java.lang.Enum<KeyedFile.Mode>

uk.co.sculptor.kflibjava.KeyedFile.Mode

All Implemented Interfaces:

Serializable, Comparable<KeyedFile.Mode>, Constable

Enclosing class:

KeyedFile

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

KeyedFile open 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
CREATE	Create the file
READ	Open the file in read only.
UPDATE	Update the file

Method Summary

Modifier and Type	Method	Description
byte	getByte()	Returns the KeyedFile open mode as the byte value used on KfServer
static KeyedFile.Mode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KeyedFile.Mode[]	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

READ

public static final KeyedFile.Mode READ

Open the file in read only.

CREATE

public static final KeyedFile.Mode CREATE

Create the file

UPDATE

public static final KeyedFile.Mode UPDATE

Update the file

Method Details

values

public static KeyedFile.Mode[] 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.Mode 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

getByte

public byte getByte()

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

Returns:

KeyedFile open mode as the byte value used on KfServer