PromiseMap (Grace Async Framework

grails.async.PromiseMap

All Implemented Interfaces and Traits:

Promise<Map<K, V>>
```
@CompileStatic
class PromiseMap<K, V>
extends Object
implements Promise<Map<K, V>>
```
A map-like structure for promises that allows waiting for all values in the map to be populated before executing a callback
Authors:
Graeme Rocher
Since:
2.3

Field Summary

Fields
Modifiers	Name	Description
`protected HashMap<K, Promise<V>>`	`promises`
`protected HashMap<Promise<V>, K>`	`promisesKeys`

Constructor Summary

Constructors
Constructor and description
`PromiseMap()`
`PromiseMap(Map<K, V> values)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Promise<Map<K, V>>`	`accept(Map<K, V> values)`
	`boolean`	`cancel(boolean mayInterruptIfRunning)`
	`boolean`	`containsKey(K o)` Parameters: `o` - The key
	`Promise`	`get(K o)` Gets a promise instance for the given key
	`Map<K, V>`	`get()` Synchronously return the populated map with all values obtained from promises used inside the populated map
	`Map<K, V>`	`get(long timeout, TimeUnit units)` Synchronously return the populated map with all values obtained from promises used inside the populated map
	`Promise`	`getAt(K o)` Gets a promise instance for the given key
	`boolean`	`isCancelled()`
	`boolean`	`isDone()`
	`boolean`	`isEmpty()` Returns: Whether the map is empty
	`Promise<Map<K, V>>`	`leftShift(Closure callable)`
	`Promise<Map<K, V>>`	`onComplete(Closure callable)`
	`Promise<Map<K, V>>`	`onError(Closure callable)`
	`Promise`	`put(K k, Object value)` Put any value and return a promise for that value
	`Promise`	`put(K k, Promise<V> promise)` Adds a promise for the given key
	`Promise`	`put(K k, Closure<V> callable)` Adds a promise for the given key
	`Promise`	`putAt(String k, Promise promise)` Adds a promise for the given key
	`Promise`	`putAt(String k, Closure promise)` Adds a promise for the given key
	`Promise`	`putAt(String k, Object value)` Adds a promise for the given key
	`Promise`	`putAt(Integer k, Promise promise)` Adds a promise for the given key
	`Promise`	`putAt(Integer k, Closure promise)` Adds a promise for the given key
	`int`	`size()` Returns: The size the map
	`Promise<Map<K, V>>`	`then(Closure callable)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - protected HashMap<K, Promise<V>> promises
  - protected HashMap<Promise<V>, K> promisesKeys
- Constructor Detail
  - PromiseMap()
  - PromiseMap(Map<K, V> values)
- Method Detail
  - @Override
    Promise<Map<K, V>> accept(Map<K, V> values)
  - @Override
    boolean cancel(boolean mayInterruptIfRunning)
  - boolean containsKey(K o)
    
    Parameters:
    o - The key
    Returns:
    Whether the promise map contains the given key
  - Promise get(K o)
    
    Gets a promise instance for the given key
    Parameters:
    o - The key
    Returns:
    A promise
  - @Override
    Map<K, V> get()
    
    Synchronously return the populated map with all values obtained from promises used inside the populated map
    Returns:
    A map where the values are obtained from the promises
  - @Override
    Map<K, V> get(long timeout, TimeUnit units)
    
    Synchronously return the populated map with all values obtained from promises used inside the populated map
    Parameters:
    timeout - The timeout period
    units - The timeout units
    Returns:
    A map where the values are obtained from the promises
  - Promise getAt(K o)
    
    Gets a promise instance for the given key
    Parameters:
    o - The key
    Returns:
    A promise
  - @Override
    boolean isCancelled()
  - @Override
    boolean isDone()
  - boolean isEmpty()
    
    Returns:
    Whether the map is empty
  - Promise<Map<K, V>> leftShift(Closure callable)
  - @Override
    Promise<Map<K, V>> onComplete(Closure callable)
  - @Override
    Promise<Map<K, V>> onError(Closure callable)
  - Promise put(K k, Object value)
    
    Put any value and return a promise for that value
    Parameters:
    k - The key
    value - The value
    Returns:
    The promise
  - Promise put(K k, Promise<V> promise)
    
    Adds a promise for the given key
    Parameters:
    k - The key
    promise - The promise
    Returns:
    The previous promise
  - Promise put(K k, Closure<V> callable)
    
    Adds a promise for the given key
    Parameters:
    k - The key
    promise - The promise
    Returns:
    The previous promise
  - Promise putAt(String k, Promise promise)
    
    Adds a promise for the given key
    Parameters:
    k - The key
    promise - The promise
    Returns:
    The previous promise
  - Promise putAt(String k, Closure promise)
    
    Adds a promise for the given key
    Parameters:
    k - The key
    promise - The promise
    Returns:
    The previous promise
  - Promise putAt(String k, Object value)
    
    Adds a promise for the given key
    Parameters:
    k - The key
    promise - The promise
    Returns:
    The previous promise
  - Promise putAt(Integer k, Promise promise)
    
    Adds a promise for the given key
    Parameters:
    k - The key
    promise - The promise
    Returns:
    The previous promise
  - Promise putAt(Integer k, Closure promise)
    
    Adds a promise for the given key
    Parameters:
    k - The key
    promise - The promise
    Returns:
    The previous promise
  - int size()
    
    Returns:
    The size the map
  - @Override
    Promise<Map<K, V>> then(Closure callable)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class PromiseMap<K, V>

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected HashMap<K, Promise<V>> promises

protected HashMap<Promise<V>, K> promisesKeys

Constructor Detail

PromiseMap()

PromiseMap(Map<K, V> values)

Method Detail

@Override
Promise<Map<K, V>> accept(Map<K, V> values)

@Override
boolean cancel(boolean mayInterruptIfRunning)

boolean containsKey(K o)

Promise get(K o)

@Override
Map<K, V> get()

@Override
Map<K, V> get(long timeout, TimeUnit units)

Promise getAt(K o)

@Override
boolean isCancelled()

@Override
boolean isDone()

boolean isEmpty()

Promise<Map<K, V>> leftShift(Closure callable)

@Override
Promise<Map<K, V>> onComplete(Closure callable)

@Override
Promise<Map<K, V>> onError(Closure callable)

Promise put(K k, Object value)

Promise put(K k, Promise<V> promise)

Promise put(K k, Closure<V> callable)

Promise putAt(String k, Promise promise)

Promise putAt(String k, Closure promise)

Promise putAt(String k, Object value)

Promise putAt(Integer k, Promise promise)

Promise putAt(Integer k, Closure promise)

int size()

@Override
Promise<Map<K, V>> then(Closure callable)

[Groovy] Class PromiseMap<K, V>

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected HashMap<K, Promise<V>> promises

protected HashMap<Promise<V>, K> promisesKeys

Constructor Detail

PromiseMap()

PromiseMap(Map<K, V> values)

Method Detail

@OverridePromise<Map<K, V>> accept(Map<K, V> values)

@Overrideboolean cancel(boolean mayInterruptIfRunning)

boolean containsKey(K o)

Promise get(K o)

@OverrideMap<K, V> get()

@OverrideMap<K, V> get(long timeout, TimeUnit units)

Promise getAt(K o)

@Overrideboolean isCancelled()

@Overrideboolean isDone()

boolean isEmpty()

Promise<Map<K, V>> leftShift(Closure callable)

@OverridePromise<Map<K, V>> onComplete(Closure callable)

@OverridePromise<Map<K, V>> onError(Closure callable)

Promise put(K k, Object value)

Promise put(K k, Promise<V> promise)

Promise put(K k, Closure<V> callable)

Promise putAt(String k, Promise promise)

Promise putAt(String k, Closure promise)

Promise putAt(String k, Object value)

Promise putAt(Integer k, Promise promise)

Promise putAt(Integer k, Closure promise)

int size()

@OverridePromise<Map<K, V>> then(Closure callable)

@Override
Promise<Map<K, V>> accept(Map<K, V> values)

@Override
boolean cancel(boolean mayInterruptIfRunning)

@Override
Map<K, V> get()

@Override
Map<K, V> get(long timeout, TimeUnit units)

@Override
boolean isCancelled()

@Override
boolean isDone()

@Override
Promise<Map<K, V>> onComplete(Closure callable)

@Override
Promise<Map<K, V>> onError(Closure callable)

@Override
Promise<Map<K, V>> then(Closure callable)