PromiseList (Grails Async 6.0.0-M1)

grails.async.PromiseList

All Implemented Interfaces and Traits:: Promise<java.util.List<T>>

@groovy.transform.AutoFinal
@groovy.transform.CompileStatic
class PromiseList<T>
extends java.lang.Object
implements Promise<java.util.List<T>>

A list of promises

Authors:: Graeme Rocher

Since:: 2.3

Field Summary

Fields
Modifiers	Name	Description
`protected java.util.List<T>`	`initialized`
`protected java.util.List<Promise<T>>`	`promises`

Constructor Summary

Constructors
Constructor and description
`PromiseList ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Promise<java.util.List<T>>`	`accept(java.util.List<T> value)`
	`boolean`	`add(T value)` Implementation of add that adds any value as a bound promise
	`boolean`	`add(groovy.lang.Closure<T> closure)` Implementation of add that takes a closure and creates a promise, adding it to the list
	`boolean`	`add(Promise<T> promise)` Implementation of add that takes a promise, adding it to the list
	`boolean`	`cancel(boolean mayInterruptIfRunning)` Synchronously obtains all the values from all the promises
	`java.util.List<T>`	`get()`
	`java.util.List<T>`	`get(long timeout, java.util.concurrent.TimeUnit units)`
	`boolean`	`isCancelled()`
	`boolean`	`isDone()`
	`PromiseList<T>`	`leftShift(groovy.lang.Closure<T> callable)` Add a callable to the promise list
	`PromiseList<T>`	`leftShift(T value)` Add a value as a bound promise to the list of values
	`PromiseList<T>`	`leftShift(Promise<T> promise)` Add a promise to the promise list
	`Promise<java.util.List<T>>`	`onComplete(groovy.lang.Closure callable)` Execute the given closure when all promises are complete
	`Promise<java.util.List<T>>`	`onError(groovy.lang.Closure callable)`
	`Promise<java.util.List<T>>`	`then(groovy.lang.Closure callable)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected java.util.List<T> initialized
  - protected java.util.List<Promise<T>> promises
- Constructor Detail
  - PromiseList()
- Method Detail
  - @java.lang.Override Promise<java.util.List<T>> accept(java.util.List<T> value)
  - boolean add(T value)
    
    Implementation of add that adds any value as a bound promise
    Parameters:
    value - The value
    Returns:
    True if it was added
  - boolean add(groovy.lang.Closure<T> closure)
    
    Implementation of add that takes a closure and creates a promise, adding it to the list
    Parameters:
    closure - The closure
    Returns:
    True if it was added
  - boolean add(Promise<T> promise)
    
    Implementation of add that takes a promise, adding it to the list
    Parameters:
    promise - The promise
    Returns:
    True if it was added
  - @java.lang.Override boolean cancel(boolean mayInterruptIfRunning)
    
    Synchronously obtains all the values from all the promises
    Returns:
    The values
  - @java.lang.Override java.util.List<T> get()
  - @java.lang.Override java.util.List<T> get(long timeout, java.util.concurrent.TimeUnit units)
  - @java.lang.Override boolean isCancelled()
  - @java.lang.Override boolean isDone()
  - PromiseList<T> leftShift(groovy.lang.Closure<T> callable)
    
    Add a callable to the promise list
    Parameters:
    callable - The callable closure
    Returns:
    The promise list
  - PromiseList<T> leftShift(T value)
    
    Add a value as a bound promise to the list of values
    Parameters:
    value - value
    Returns:
    The promise list
  - PromiseList<T> leftShift(Promise<T> promise)
    
    Add a promise to the promise list
    Parameters:
    promise - The promise
    Returns:
    The promise list
  - @java.lang.Override Promise<java.util.List<T>> onComplete(groovy.lang.Closure callable)
    
    Execute the given closure when all promises are complete
    Parameters:
    callable - The closure
  - @java.lang.Override Promise<java.util.List<T>> onError(groovy.lang.Closure callable)
  - @java.lang.Override Promise<java.util.List<T>> then(groovy.lang.Closure callable)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class PromiseList<T>

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected java.util.List<T> initialized

protected java.util.List<Promise<T>> promises

Constructor Detail

PromiseList()

Method Detail

@java.lang.Override Promise<java.util.List<T>> accept(java.util.List<T> value)

boolean add(T value)

boolean add(groovy.lang.Closure<T> closure)

boolean add(Promise<T> promise)

@java.lang.Override boolean cancel(boolean mayInterruptIfRunning)

@java.lang.Override java.util.List<T> get()

@java.lang.Override java.util.List<T> get(long timeout, java.util.concurrent.TimeUnit units)

@java.lang.Override boolean isCancelled()

@java.lang.Override boolean isDone()

PromiseList<T> leftShift(groovy.lang.Closure<T> callable)

PromiseList<T> leftShift(T value)

PromiseList<T> leftShift(Promise<T> promise)

@java.lang.Override Promise<java.util.List<T>> onComplete(groovy.lang.Closure callable)

@java.lang.Override Promise<java.util.List<T>> onError(groovy.lang.Closure callable)

@java.lang.Override Promise<java.util.List<T>> then(groovy.lang.Closure callable)