org.jlab.coda.jevio

Enum WriteStatus

java.lang.Object

java.lang.Enum<WriteStatus>

org.jlab.coda.jevio.WriteStatus

All Implemented Interfaces:

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

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

This enum denotes the status of a write.
SUCCESS indicates a successful write.
CANNOT_OPEN_FILE indicates that we cannot write because the destination file cannot be opened.
EVIO_EXCEPTION indicates that an EvioException was thrown during a write.
UNKNOWN_ERROR indicates that an unrecoverable error has occurred.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANNOT_OPEN_FILE Cannot open file.
EVIO_EXCEPTION Evio exception on read.
SUCCESS Successful read.
UNKNOWN_ERROR Unknown exception on read.

Method Summary

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

Successful read.

CANNOT_OPEN_FILE

public static final WriteStatus CANNOT_OPEN_FILE

Cannot open file.

EVIO_EXCEPTION

public static final WriteStatus EVIO_EXCEPTION

Evio exception on read.

UNKNOWN_ERROR

public static final WriteStatus UNKNOWN_ERROR

Unknown exception on read.

Method Detail

values

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

Returns:

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

valueOf

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