me.joeycumines.javapromises.core

Enum PromiseState

java.lang.Object

java.lang.Enum<PromiseState>

me.joeycumines.javapromises.core.PromiseState

All Implemented Interfaces:

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

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

A promise can have one of three states, pending, fulfilled, or rejected. A promise will always start in the PENDING state. A promise must ONLY ever resolve (finish / change state) ONCE, though it is still usable in it's resolved state. A promise that is REJECTED will NEVER have a null value.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULFILLED
PENDING
REJECTED

Method Summary

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

PENDING

public static final PromiseState PENDING

FULFILLED

public static final PromiseState FULFILLED

REJECTED

public static final PromiseState REJECTED

Method Detail

values

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

Returns:

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

valueOf

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