Package ke.ric.renderer.api

Enum Class RenderStatus

java.lang.Object

java.lang.Enum<RenderStatus>

ke.ric.renderer.api.RenderStatus

All Implemented Interfaces:

Serializable, Comparable<RenderStatus>, Constable

public enum RenderStatus
extends Enum<RenderStatus>

Coarse lifecycle state for an asynchronous render task.

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	Cancellation won the terminal transition.
FAILED	The task completed exceptionally for another reason.
QUEUED	Admitted and waiting for provider work.
RUNNING	Preparation, native rendering, diagnostics, or copying is in progress.
SUCCEEDED	An immutable result completed successfully.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

QUEUED

public static final RenderStatus QUEUED

Admitted and waiting for provider work.

RUNNING

public static final RenderStatus RUNNING

Preparation, native rendering, diagnostics, or copying is in progress.

SUCCEEDED

public static final RenderStatus SUCCEEDED

An immutable result completed successfully.

CANCELLED

public static final RenderStatus CANCELLED

Cancellation won the terminal transition.

FAILED

public static final RenderStatus FAILED

The task completed exceptionally for another reason.

Method Details

values

public static RenderStatus[] 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 RenderStatus 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