Package org.osgi.util.promise

Enum Class PromiseFactory.Option

java.lang.Object

java.lang.Enum<PromiseFactory.Option>

org.osgi.util.promise.PromiseFactory.Option

All Implemented Interfaces:

Serializable, Comparable<PromiseFactory.Option>, Constable

Enclosing class:

PromiseFactory

public static enum PromiseFactory.Option
extends Enum<PromiseFactory.Option>

Defines the options for a Promise factory.

The default options are no options unless the boolean system property org.osgi.util.promise.allowCurrentThread is set to false. When this is the case, the option CALLBACKS_EXECUTOR_THREAD is a default option.

Since:

1.2

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
CALLBACKS_EXECUTOR_THREAD	Run callbacks on an executor thread.

Method Summary

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

CALLBACKS_EXECUTOR_THREAD

public static final PromiseFactory.Option CALLBACKS_EXECUTOR_THREAD

Run callbacks on an executor thread. If this option is not set, callbacks added to a resolved Promise may be immediately called on the caller's thread to avoid a thread context switch.

Method Details

values

public static PromiseFactory.Option[] 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 PromiseFactory.Option 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