Package uk.co.sculptor.kflibjava

Enum Class ServerFile.SeekOrigin

java.lang.Object

java.lang.Enum<ServerFile.SeekOrigin>

uk.co.sculptor.kflibjava.ServerFile.SeekOrigin

All Implemented Interfaces:

Serializable, Comparable<ServerFile.SeekOrigin>, Constable

Enclosing class:

ServerFile

public static enum ServerFile.SeekOrigin
extends Enum<ServerFile.SeekOrigin>

Enumerator with the possible seek origins

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
SEEK_CUR	Current position of file pointer.
SEEK_END	End of file.
SEEK_SET	Beginning of file.

Method Summary

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

SEEK_CUR

public static final ServerFile.SeekOrigin SEEK_CUR

Current position of file pointer.

SEEK_END

public static final ServerFile.SeekOrigin SEEK_END

End of file.

SEEK_SET

public static final ServerFile.SeekOrigin SEEK_SET

Beginning of file.

Method Details

values

public static ServerFile.SeekOrigin[] 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 ServerFile.SeekOrigin 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()

Convert the SeekOrigin whence as the byte value used on KfServer (and the OS)

Returns:

the seek whence as the byte value used on KfServer (and the OS)