grails.async

Interface PromiseFactory

All Known Implementing Classes:

AbstractPromiseFactory

public interface PromiseFactory

An interface capable of creating Promise instances. The Promises static methods use this interface to create promises. The default Promise creation mechanism can be overriden by setting Promises.setPromiseFactory(PromiseFactory)

Since:

2.3

Method Summary

Modifier and Type	Method and Description
void	addPromiseDecoratorLookupStrategy(org.grails.async.decorator.PromiseDecoratorLookupStrategy lookupStrategy) Adds a PromiseDecoratorLookupStrategy.
<T> groovy.lang.Closure<T>	applyDecorators(groovy.lang.Closure<T> c, java.util.List<org.grails.async.decorator.PromiseDecorator> decorators) Applies the registered decorators to the given closure
<T> grails.async.Promise<T>	createBoundPromise(T value) Creates a promise with a value pre-bound to it
<T> grails.async.Promise<T>	createPromise(groovy.lang.Closure<T>... c) Creates a promise from one or many closures
<T> grails.async.Promise<T>	createPromise(groovy.lang.Closure<T> c, java.util.List<org.grails.async.decorator.PromiseDecorator> decorators) Creates a promise from one or many closures
<T> grails.async.Promise<java.util.List<T>>	createPromise(java.util.List<groovy.lang.Closure<T>> closures) Creates a promise from one or many closures
<T> grails.async.Promise<java.util.List<T>>	createPromise(java.util.List<groovy.lang.Closure<T>> closures, java.util.List<org.grails.async.decorator.PromiseDecorator> decorators) Creates a promise from one or many closures
<K,V> grails.async.Promise<java.util.Map<K,V>>	createPromise(java.util.Map<K,V> map) Creates a promise from the given map where the values of the map are either closures or Promise instances
<T> grails.async.Promise<java.util.List<T>>	createPromise(grails.async.Promise<T>... promises) Creates a promise from one or more other promises
<T> grails.async.Promise<java.util.List<T>>	onComplete(java.util.List<grails.async.Promise<T>> promises, groovy.lang.Closure<?> callable) Executes the given callback when the list of promises completes
<T> grails.async.Promise<java.util.List<T>>	onError(java.util.List<grails.async.Promise<T>> promises, groovy.lang.Closure<?> callable) Executes the given callback if an error occurs for the list of promises
<T> java.util.List<T>	waitAll(java.util.List<grails.async.Promise<T>> promises) Synchronously waits for all promises to complete returning a list of values
<T> java.util.List<T>	waitAll(java.util.List<grails.async.Promise<T>> promises, long timeout, java.util.concurrent.TimeUnit units) Synchronously waits for all promises to complete returning a list of values
<T> java.util.List<T>	waitAll(grails.async.Promise<T>... promises) Synchronously waits for all promises to complete returning a list of values

Method Detail

addPromiseDecoratorLookupStrategy

void addPromiseDecoratorLookupStrategy(org.grails.async.decorator.PromiseDecoratorLookupStrategy lookupStrategy)

Adds a PromiseDecoratorLookupStrategy. The strategy implementation must be stateless, do not add a strategy that contains state

Parameters:

lookupStrategy - The lookup strategy

applyDecorators

<T> groovy.lang.Closure<T> applyDecorators(groovy.lang.Closure<T> c,
                                           java.util.List<org.grails.async.decorator.PromiseDecorator> decorators)

Applies the registered decorators to the given closure

Parameters:

c - The closure

decorators - The decorators

Returns:

The decorated closure

createBoundPromise

<T> grails.async.Promise<T> createBoundPromise(T value)

Creates a promise with a value pre-bound to it

Type Parameters:

T - The type of the value

Parameters:

value - The value

Returns:

A Promise

createPromise

<K,V> grails.async.Promise<java.util.Map<K,V>> createPromise(java.util.Map<K,V> map)

Creates a promise from the given map where the values of the map are either closures or Promise instances

Parameters:

map - The map

Returns:

A promise

createPromise

<T> grails.async.Promise<java.util.List<T>> createPromise(grails.async.Promise<T>... promises)

Creates a promise from one or more other promises

Parameters:

promises - The promises

Returns:

The promise

createPromise

<T> grails.async.Promise<T> createPromise(groovy.lang.Closure<T>... c)

Creates a promise from one or many closures

Parameters:

c - One or many closures

Returns:

A promise

createPromise

<T> grails.async.Promise<T> createPromise(groovy.lang.Closure<T> c,
                                          java.util.List<org.grails.async.decorator.PromiseDecorator> decorators)

Creates a promise from one or many closures

Parameters:

c - One or many closures

Returns:

A promise

createPromise

<T> grails.async.Promise<java.util.List<T>> createPromise(java.util.List<groovy.lang.Closure<T>> closures,
                                                          java.util.List<org.grails.async.decorator.PromiseDecorator> decorators)

Creates a promise from one or many closures

Parameters:

closures - One or many closures

Returns:

A promise

createPromise

<T> grails.async.Promise<java.util.List<T>> createPromise(java.util.List<groovy.lang.Closure<T>> closures)

Creates a promise from one or many closures

Parameters:

closures - One or many closures

Returns:

A promise

waitAll

<T> java.util.List<T> waitAll(grails.async.Promise<T>... promises)

Synchronously waits for all promises to complete returning a list of values

Parameters:

promises - The promises

Returns:

The list of bound values

waitAll

<T> java.util.List<T> waitAll(java.util.List<grails.async.Promise<T>> promises)

Synchronously waits for all promises to complete returning a list of values

Parameters:

promises - The promises

Returns:

The list of bound values

waitAll

<T> java.util.List<T> waitAll(java.util.List<grails.async.Promise<T>> promises,
                              long timeout,
                              java.util.concurrent.TimeUnit units)

Synchronously waits for all promises to complete returning a list of values

Parameters:

promises - The promises

Returns:

The list of bound values

onComplete

<T> grails.async.Promise<java.util.List<T>> onComplete(java.util.List<grails.async.Promise<T>> promises,
                                                       groovy.lang.Closure<?> callable)

Executes the given callback when the list of promises completes

Parameters:

promises - The promises

callable - The callback to execute

onError

<T> grails.async.Promise<java.util.List<T>> onError(java.util.List<grails.async.Promise<T>> promises,
                                                    groovy.lang.Closure<?> callable)

Executes the given callback if an error occurs for the list of promises

Parameters:

promises - The promises The promises

callable - The error callback to execute