Package org.gbif.api.model.occurrence

Enum Class Download.Status

java.lang.Object

java.lang.Enum<Download.Status>

org.gbif.api.model.occurrence.Download.Status

All Implemented Interfaces:

Serializable, Comparable<Download.Status>, Constable

Enclosing class:

Download

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

Reflects the possibles statuses of a download during its execution. The download statuses are: - PREPARING: the download is in a queue, waiting for other downloads to complete - RUNNING: the download is being processed - SUCCEEDED: the file is ready to be downloaded - CANCELLED: the download was cancelled by the user - KILLED: the download was killed by the workflow engine - FAILED: the download failed - SUSPENDED: the download was paused and its execution will be resumed later - FILE_ERASED: the download was successful, but the download file has been deleted

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED
FAILED
FILE_ERASED
KILLED
PREPARING
RUNNING
SUCCEEDED
SUSPENDED

Field Summary

Fields

Modifier and Type	Field	Description
static final EnumSet<Download.Status>	EXECUTING_STATUSES	Statuses that represent a download that that hasn't finished.
static final EnumSet<Download.Status>	FINISH_STATUSES	Statuses that represent a download that that has finished.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PREPARING

public static final Download.Status PREPARING

RUNNING

public static final Download.Status RUNNING

SUCCEEDED

public static final Download.Status SUCCEEDED

CANCELLED

public static final Download.Status CANCELLED

KILLED

public static final Download.Status KILLED

FAILED

public static final Download.Status FAILED

SUSPENDED

public static final Download.Status SUSPENDED

FILE_ERASED

public static final Download.Status FILE_ERASED

Field Details

EXECUTING_STATUSES

public static final EnumSet<Download.Status> EXECUTING_STATUSES

Statuses that represent a download that that hasn't finished.

FINISH_STATUSES

public static final EnumSet<Download.Status> FINISH_STATUSES

Statuses that represent a download that that has finished.

Method Details

values

public static Download.Status[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Download.Status valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null