com.dxfeed.promise

Class Promises

java.lang.Object

com.dxfeed.promise.Promises

public final class Promises
extends Object

Utility methods to manipulate promises.

Method Summary

Modifier and Type	Method and Description
static Promise<Void>	allOf(Collection<? extends Promise<?>> promises) Returns a new promise that completes when all promises from the given collection complete normally or exceptionally.
static Promise<Void>	allOf(Promise<?>... promises) Returns a new promise that completes when all promises from the given array complete normally or exceptionally.
static <T> Promise<T>	anyOf(Collection<? extends Promise<T>> promises) Returns a new promise that completes when any promise from the given collection complete normally or exceptionally.
static <T> Promise<T>	anyOf(Promise<T>... promises) Returns a new promise that completes when any promise from the given array complete normally or exceptionally.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

allOf

public static Promise<Void> allOf(Collection<? extends Promise<?>> promises)

Returns a new promise that completes when all promises from the given collection complete normally or exceptionally. The results of the given promises are not reflected in the returned promise, but may be obtained by inspecting them individually. If no promises are provided, returns a promise completed with the value null. When the resulting promise completes for any reason (is canceled, for example) then all of the promises from the given collection are canceled.

Parameters:

promises - a collection of promises.

Returns:

a new promise that completes when all promises from the given collection complete.

Throws:

NullPointerException - if promises is null or any individual promise there is null.

allOf

public static Promise<Void> allOf(Promise<?>... promises)

Returns a new promise that completes when all promises from the given array complete normally or exceptionally. The results of the given promises are not reflected in the returned promise, but may be obtained by inspecting them individually. If no promises are provided, returns a promise completed with the value null. When the resulting promise completes for any reason (is canceled, for example) then all of the promises from the given array are canceled.

Parameters:

promises - an array of promises.

Returns:

a new promise that completes when all promises from the given array complete.

Throws:

NullPointerException - if promises is null or any individual promise there is null.

anyOf

public static <T> Promise<T> anyOf(Collection<? extends Promise<T>> promises)

Returns a new promise that completes when any promise from the given collection complete normally or exceptionally. If any of the given promises complete exceptionally, then the returned promise also does so with the same exception and all non-completed promises in the list are canceled. If any of the given promises complete with result, then the returned promise also does so with the same result and all non-completed promises in the list are canceled. When the resulting promise completes for any reason (is canceled, for example) then all of the promises from the given collection are canceled.

Parameters:

promises - a collection of promises.

Returns:

a new promise that completes when any promise from the given collection completes.

Throws:

NullPointerException - if promises is null or any individual promise there is null.

anyOf

public static <T> Promise<T> anyOf(Promise<T>... promises)

Returns a new promise that completes when any promise from the given array complete normally or exceptionally. If any of the given promises complete exceptionally, then the returned promise also does so with the same exception and all non-completed promises in the list are canceled. If any of the given promises complete with result, then the returned promise also does so with the same result and all non-completed promises in the list are canceled. When the resulting promise completes for any reason (is canceled, for example) then all of the promises from the given array are canceled.

Parameters:

promises - a collection of promises.

Returns:

a new promise that completes when any promise from the given array completes.

Throws:

NullPointerException - if promises is null or any individual promise there is null.