org.jlab.coda.jevio

Enum ReadStatus

java.lang.Object

java.lang.Enum<ReadStatus>

org.jlab.coda.jevio.ReadStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ReadStatus>

public enum ReadStatus
extends java.lang.Enum<ReadStatus>

This enum denotes the status of a read.
SUCCESS indicates a successful read.
END_OF_FILE indicates that we cannot read because an END_OF_FILE has occurred. Technically this means that what ever we are trying to read is larger than the buffer's unread bytes.
EVIO_EXCEPTION indicates that an EvioException was thrown during a read, possibly due to out of range values, such as a negative start position.
UNKNOWN_ERROR indicates that an unrecoverable error has occurred.

Enum Constant Summary

Enum Constants

Enum Constant and Description
END_OF_FILE End of file condition.
EVIO_EXCEPTION Evio exception on read.
SUCCESS Successful read.
UNKNOWN_ERROR Unknown exception on read.

Method Summary

Modifier and Type	Method and Description
static ReadStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ReadStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final ReadStatus SUCCESS

Successful read.

END_OF_FILE

public static final ReadStatus END_OF_FILE

End of file condition.

EVIO_EXCEPTION

public static final ReadStatus EVIO_EXCEPTION

Evio exception on read.

UNKNOWN_ERROR

public static final ReadStatus UNKNOWN_ERROR

Unknown exception on read.

Method Detail

values

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

Returns:

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

valueOf

public static ReadStatus valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null