Package edu.byu.hbll.box

Enum BoxDocument.Status

java.lang.Object

java.lang.Enum<BoxDocument.Status>

edu.byu.hbll.box.BoxDocument.Status

All Implemented Interfaces:

Serializable, Comparable<BoxDocument.Status>

Enclosing class:

BoxDocument

public static enum BoxDocument.Status
extends Enum<BoxDocument.Status>

Status of the document.

Author:

Charles Draper

Enum Constant Summary

Enum Constants

Enum Constant	Description
DELETED	The document has been deleted.
ERROR	There was an error in the processing.
READY	The document has been processed and is ready to use.
UNPROCESSED	The document is new and has not yet been processed.

Method Summary

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

UNPROCESSED

public static final BoxDocument.Status UNPROCESSED

The document is new and has not yet been processed.

READY

public static final BoxDocument.Status READY

The document has been processed and is ready to use.

DELETED

public static final BoxDocument.Status DELETED

The document has been deleted.

ERROR

public static final BoxDocument.Status ERROR

There was an error in the processing.

Method Detail

values

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

Returns:

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

valueOf

public static BoxDocument.Status 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