org.ogf.saga.file

Enum SeekMode

java.lang.Object

java.lang.Enum<SeekMode>

org.ogf.saga.file.SeekMode

All Implemented Interfaces:

Serializable, Comparable<SeekMode>

public enum SeekMode
extends Enum<SeekMode>

Determines the seekmode for File.seek(long, org.ogf.saga.file.SeekMode): the specified offset is interpreted with respect to the start, the current position, or the end.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CURRENT Seek from the current position in the file.
END Seek from the end of the file.
START Seek from the start of the file.

Method Summary

Methods

Modifier and Type	Method and Description
int	getValue() Returns the integer value of this enumeration literal.
static SeekMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SeekMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

START

public static final SeekMode START

Seek from the start of the file.

CURRENT

public static final SeekMode CURRENT

Seek from the current position in the file.

END

public static final SeekMode END

Seek from the end of the file.

Method Detail

values

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

Returns:

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

valueOf

public static SeekMode valueOf(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:

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

NullPointerException - if the argument is null

getValue

public int getValue()

Returns the integer value of this enumeration literal.

Returns:

the integer value.