net.openhft.posix

Enum WhenceFlag

java.lang.Object

java.lang.Enum<WhenceFlag>

net.openhft.posix.WhenceFlag

All Implemented Interfaces:

Serializable, Comparable<WhenceFlag>

public enum WhenceFlag
extends Enum<WhenceFlag>

This enum represents the different flags for seeking within a file (whence). It defines the options used to set the file offset for read/write operations.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SEEK_CUR The offset is set to its current location plus offset bytes.
SEEK_DATA Adjust the file offset to the next location in the file greater than or equal to offset containing data.
SEEK_END The offset is set to the size of the file plus offset bytes.
SEEK_HOLE Adjust the file offset to the next hole in the file greater than or equal to offset.
SEEK_SET The offset is set to offset bytes.

Method Summary

Modifier and Type	Method and Description
int	value() This method is a getter for the value instance variable.
static WhenceFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static WhenceFlag[]	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

SEEK_SET

public static final WhenceFlag SEEK_SET

The offset is set to offset bytes.

SEEK_CUR

public static final WhenceFlag SEEK_CUR

The offset is set to its current location plus offset bytes.

SEEK_END

public static final WhenceFlag SEEK_END

The offset is set to the size of the file plus offset bytes.

SEEK_DATA

public static final WhenceFlag SEEK_DATA

Adjust the file offset to the next location in the file greater than or equal to offset containing data. If offset points to data, then the file offset is set to offset.

SEEK_HOLE

public static final WhenceFlag SEEK_HOLE

Adjust the file offset to the next hole in the file greater than or equal to offset. If offset points into the middle of a hole, then the file offset is set to offset. If there is no hole past offset, then the file offset is adjusted to the end of the file (i.e., there is an implicit hole at the end of any file).

Method Detail

values

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

Returns:

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

valueOf

public static WhenceFlag 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

value

public int value()

This method is a getter for the value instance variable. It returns the current integer value of this WhenceFlag object.

Returns:

The current integer value of this WhenceFlag object