org.jlab.coda.jevio

Enum EvioReader.ReadStatus

java.lang.Object

java.lang.Enum<EvioReader.ReadStatus>

org.jlab.coda.jevio.EvioReader.ReadStatus

All Implemented Interfaces:

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

Enclosing class:

EvioReader

public static enum EvioReader.ReadStatus
extends java.lang.Enum<EvioReader.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
EVIO_EXCEPTION
SUCCESS
UNKNOWN_ERROR

Method Summary

Methods

Modifier and Type	Method and Description
static EvioReader.ReadStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EvioReader.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 EvioReader.ReadStatus SUCCESS

END_OF_FILE

public static final EvioReader.ReadStatus END_OF_FILE

EVIO_EXCEPTION

public static final EvioReader.ReadStatus EVIO_EXCEPTION

UNKNOWN_ERROR

public static final EvioReader.ReadStatus UNKNOWN_ERROR

Method Detail

values

public static EvioReader.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 (EvioReader.ReadStatus c : EvioReader.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 EvioReader.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