Package org.osgi.util.promise

Enum PromiseFactory.Option

java.lang.Object

java.lang.Enum<PromiseFactory.Option>

org.osgi.util.promise.PromiseFactory.Option

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PromiseFactory.Option>

Enclosing class:

PromiseFactory

public static enum PromiseFactory.Option
extends java.lang.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

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(java.lang.String name)	Returns the enum constant of this type with the specified name.
static PromiseFactory.Option[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

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

Returns:

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

valueOf

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