PromiseMap (Grails Async 6.0.0-M1)

grails.async.PromiseMap

All Implemented Interfaces and Traits:

Promise<java.util.Map<K, V>>
```
@groovy.transform.AutoFinal
@groovy.transform.CompileStatic
class PromiseMap<K, V>
extends java.lang.Object
implements Promise<java.util.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 java.util.LinkedHashMap<K, Promise<V>>`	`promises`
`protected java.util.LinkedHashMap<Promise<V>, K>`	`promisesKeys`

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Promise<java.util.Map<K, V>>`	`accept(java.util.Map<K, V> values)`
	`boolean`	`cancel(boolean mayInterruptIfRunning)`
	`boolean`	`containsKey(K key)` Parameters: `key` - The key
	`Promise<V>`	`get(K key)` Gets a promise instance for the given key
	`java.util.Map<K, V>`	`get()` Synchronously return the populated map with all values obtained from promises used inside the populated map
	`java.util.Map<K, V>`	`get(long timeout, java.util.concurrent.TimeUnit units)` Synchronously return the populated map with all values obtained from promises used inside the populated map
	`Promise<V>`	`getAt(K key)` Gets a promise instance for the given key
	`boolean`	`isCancelled()`
	`boolean`	`isDone()`
	`boolean`	`isEmpty()` Returns: Whether the map is empty
	`Promise<java.util.Map<K, V>>`	`leftShift(groovy.lang.Closure callable)`
	`Promise<java.util.Map<K, V>>`	`onComplete(groovy.lang.Closure<java.util.Map<K, V>> callable)`
	`Promise<java.util.Map<K, V>>`	`onError(groovy.lang.Closure<java.util.Map<K, V>> callable)`
	`Promise<V>`	`put(K key, V value)` Put any value and return a promise for that value
	`Promise<V>`	`put(K key, Promise<V> promise)` Adds a promise for the given key
	`Promise<V>`	`put(K key, groovy.lang.Closure<V> callable)` Adds a callable for the given key
	`Promise<V>`	`putAt(java.lang.String key, Promise<V> promise)` Adds a promise for the given key
	`Promise<V>`	`putAt(java.lang.String key, groovy.lang.Closure<V> callable)` Adds a callable for the given key
	`Promise<V>`	`putAt(java.lang.String key, V value)` Adds a value for the given key
	`Promise<V>`	`putAt(java.lang.Integer key, Promise<V> promise)` Adds a promise for the given key
	`Promise<V>`	`putAt(java.lang.Integer key, groovy.lang.Closure<V> callable)` Adds a promise for the given key
	`int`	`size()` Returns: The size the map
	`Promise<java.util.Map<K, V>>`	`then(groovy.lang.Closure<java.util.Map<K, V>> 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.LinkedHashMap<K, Promise<V>> promises
  - protected java.util.LinkedHashMap<Promise<V>, K> promisesKeys
- Constructor Detail
  - PromiseMap()
  - PromiseMap(java.util.Map<K, V> values)
- Method Detail
  - @java.lang.Override Promise<java.util.Map<K, V>> accept(java.util.Map<K, V> values)
  - @java.lang.Override boolean cancel(boolean mayInterruptIfRunning)
  - boolean containsKey(K key)
    
    Parameters:
    key - The key
    Returns:
    Whether the promise map contains the given key
  - Promise<V> get(K key)
    
    Gets a promise instance for the given key
    Parameters:
    o - The key
    Returns:
    A promise
  - java.util.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
  - java.util.Map<K, V> get(long timeout, java.util.concurrent.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<V> getAt(K key)
    
    Gets a promise instance for the given key
    Parameters:
    key - The key
    Returns:
    A promise
  - @java.lang.Override boolean isCancelled()
  - @java.lang.Override boolean isDone()
  - boolean isEmpty()
    
    Returns:
    Whether the map is empty
  - Promise<java.util.Map<K, V>> leftShift(groovy.lang.Closure callable)
  - @java.lang.Override Promise<java.util.Map<K, V>> onComplete(groovy.lang.Closure<java.util.Map<K, V>> callable)
  - @java.lang.Override Promise<java.util.Map<K, V>> onError(groovy.lang.Closure<java.util.Map<K, V>> callable)
  - Promise<V> put(K key, V value)
    
    Put any value and return a promise for that value
    Parameters:
    key - The key
    value - The value
    Returns:
    The previous promise associated with the key or null
  - Promise<V> put(K key, Promise<V> promise)
    
    Adds a promise for the given key
    Parameters:
    key - The key
    promise - The promise
    Returns:
    The previous promise associated with the key or null
  - Promise<V> put(K key, groovy.lang.Closure<V> callable)
    
    Adds a callable for the given key
    Parameters:
    key - The key
    callable - The closure to call
    Returns:
    The previous promise associated with the key or null
  - Promise<V> putAt(java.lang.String key, Promise<V> promise)
    
    Adds a promise for the given key
    Parameters:
    key - The key
    promise - The promise
    Returns:
    The previous promise associated with the key or null
  - Promise<V> putAt(java.lang.String key, groovy.lang.Closure<V> callable)
    
    Adds a callable for the given key
    Parameters:
    key - The key
    callable - The closure to call
    Returns:
    The previous promise associated with the key or null
  - Promise<V> putAt(java.lang.String key, V value)
    
    Adds a value for the given key
    Parameters:
    key - The key
    value - The value
    Returns:
    The previous promise associated with the key or null
  - Promise<V> putAt(java.lang.Integer key, Promise<V> promise)
    
    Adds a promise for the given key
    Parameters:
    key - The key
    promise - The promise
    Returns:
    The previous promise associated with the key or null
  - Promise<V> putAt(java.lang.Integer key, groovy.lang.Closure<V> callable)
    
    Adds a promise for the given key
    Parameters:
    key - The key
    callable - The closure to call
    Returns:
    The previous promise associated with the key or null
  - int size()
    
    Returns:
    The size the map
  - @java.lang.Override Promise<java.util.Map<K, V>> then(groovy.lang.Closure<java.util.Map<K, V>> 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 java.util.LinkedHashMap<K, Promise<V>> promises

protected java.util.LinkedHashMap<Promise<V>, K> promisesKeys

Constructor Detail

PromiseMap()

PromiseMap(java.util.Map<K, V> values)

Method Detail

@java.lang.Override Promise<java.util.Map<K, V>> accept(java.util.Map<K, V> values)

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

boolean containsKey(K key)

Promise<V> get(K key)

java.util.Map<K, V> get()

java.util.Map<K, V> get(long timeout, java.util.concurrent.TimeUnit units)

Promise<V> getAt(K key)

@java.lang.Override boolean isCancelled()

@java.lang.Override boolean isDone()

boolean isEmpty()

Promise<java.util.Map<K, V>> leftShift(groovy.lang.Closure callable)

@java.lang.Override Promise<java.util.Map<K, V>> onComplete(groovy.lang.Closure<java.util.Map<K, V>> callable)

@java.lang.Override Promise<java.util.Map<K, V>> onError(groovy.lang.Closure<java.util.Map<K, V>> callable)

Promise<V> put(K key, V value)

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

Promise<V> put(K key, groovy.lang.Closure<V> callable)

Promise<V> putAt(java.lang.String key, Promise<V> promise)

Promise<V> putAt(java.lang.String key, groovy.lang.Closure<V> callable)

Promise<V> putAt(java.lang.String key, V value)

Promise<V> putAt(java.lang.Integer key, Promise<V> promise)

Promise<V> putAt(java.lang.Integer key, groovy.lang.Closure<V> callable)

int size()

@java.lang.Override Promise<java.util.Map<K, V>> then(groovy.lang.Closure<java.util.Map<K, V>> callable)