Promise (org.codehaus.gpars)

groovyx.gpars.dataflow.SelectableChannel

All Superinterfaces:

SelectableChannel

A unifying future-like interface to dataflow variables, asynchronous functions and active objects. Represents the read end of DataflowVariables.
Authors:
Vaclav Pech

Methods Summary

Methods
Type	Name and description
`T`	`get()` Retrieves the value of the variable, blocking until a value is available
`T`	`get(long timeout, java.util.concurrent.TimeUnit units)` Retrieves the value of the variable, blocking up to given timeout, if the value has not been assigned yet.
`java.lang.Throwable`	`getError()` Returns the error bound to the promise
`boolean`	`isBound()` Check if value has been set already for this expression
`boolean`	`isError()` Checks if the promise is bound to an error
`void`	`join()` // * Asynchronously retrieves the value from the channel.
`void`	`join(long timeout, java.util.concurrent.TimeUnit units)` Blocks, if the value has not been assigned yet to the DataflowVariable
`Promise<V>`	`rightShift(groovy.lang.Closure<V> closure)` Schedule closure to be executed after data became available.
`Promise<V>`	`then(groovy.lang.Closure<V> closure)` Schedule closure to be executed after data became available.
`Promise<V>`	`then(Pool pool, groovy.lang.Closure<V> closure)` Schedule closure to be executed after data becomes available.
`Promise<V>`	`then(PGroup group, groovy.lang.Closure<V> closure)` Schedule closure to be executed after data becomes available.
`Promise<V>`	`then(groovy.lang.Closure<V> closure, groovy.lang.Closure<V> errorHandler)` Schedule closure to be executed after data became available.
`Promise<V>`	`then(Pool pool, groovy.lang.Closure<V> closure, groovy.lang.Closure<V> errorHandler)` Schedule closure to be executed after data becomes available.
`Promise<V>`	`then(PGroup group, groovy.lang.Closure<V> closure, groovy.lang.Closure<V> errorHandler)` Schedule closure to be executed after data becomes available.
`Promise<java.util.List>`	`thenForkAndJoin(groovy.lang.Closure<? extends java.lang.Object>... closures)` Schedule a set of closures to be executed after data became available on the current promise.
`Promise<java.util.List>`	`thenForkAndJoin(Pool pool, groovy.lang.Closure<? extends java.lang.Object>... closures)` Schedule a set of closures to be executed after data became available on the current promise.
`Promise<java.util.List>`	`thenForkAndJoin(PGroup group, groovy.lang.Closure<? extends java.lang.Object>... closures)` Schedule a set of closures to be executed after data became available on the current promise.
`void`	`touch()` May be used by lazy implementations to warm up
`void`	`whenBound(groovy.lang.Closure<V> closure)` Schedule closure to be executed after data becomes available.
`void`	`whenBound(Pool pool, groovy.lang.Closure<V> closure)` Schedule closure to be executed after data becomes available.
`void`	`whenBound(PGroup group, groovy.lang.Closure<V> closure)` Schedule closure to be executed after data becomes available.
`void`	`whenBound(MessageStream stream)` Send the bound data to provided stream when it becomes available

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface SelectableChannel`	`poll, wheneverBound, wheneverBound`

- Method Detail
  - @java.lang.SuppressWarnings({"ProhibitedExceptionDeclared"}) public T get()
    
    Retrieves the value of the variable, blocking until a value is available
    throws:
    Throwable If the stored value is an exception instance it gets re-thrown
    
    Returns:
    The value stored in the variable
  - @java.lang.SuppressWarnings({"ProhibitedExceptionDeclared"}) public T get(long timeout, java.util.concurrent.TimeUnit units)
    
    Retrieves the value of the variable, blocking up to given timeout, if the value has not been assigned yet.
    throws:
    Throwable If the stored value is an exception instance it gets re-thrown
    
    Returns:
    The value stored in the variable
    Parameters:
    timeout - The timeout value
    units - Units for the timeout
  - public java.lang.Throwable getError()
    
    Returns the error bound to the promise
    throws:
    IllegalStateException If not bound or not bound to an error
    
    Returns:
    The error
  - public boolean isBound()
    
    Check if value has been set already for this expression
    Returns:
    true if bound already
  - public boolean isError()
    
    Checks if the promise is bound to an error
    Returns:
    True, if an error has been bound
  - public void join()
    
    // * Asynchronously retrieves the value from the channel. Sends the actual value of the channel as a message // * back the the supplied actor once the value has been bound. // * The actor can perform other activities or release a thread back to the pool by calling react() waiting for the message // * with the value of the Dataflow channel. // * // *
    Parameters:
    callback - An actor to send the bound value to. //
  - public void join(long timeout, java.util.concurrent.TimeUnit units)
    
    Blocks, if the value has not been assigned yet to the DataflowVariable
    throws:
    InterruptedException If the current thread gets interrupted while waiting for the variable to be bound
    
    Parameters:
    timeout - The timeout value
    units - Units for the timeout
  - public Promise<V> rightShift(groovy.lang.Closure<V> closure)
    
    Schedule closure to be executed after data became available. It is important to notice that even if the expression is already bound the execution of closure will not happen immediately but will be scheduled
    Returns:
    A promise for the results of the supplied closure. This allows for chaining of then() method calls.
    Parameters:
    closure - closure to execute when data becomes available. The closure should take at most one argument.
  - public Promise<V> then(groovy.lang.Closure<V> closure)
    
    Schedule closure to be executed after data became available. It is important to notice that even if the expression is already bound the execution of closure will not happen immediately but will be scheduled
    Returns:
    A promise for the results of the supplied closure. This allows for chaining of then() method calls.
    Parameters:
    closure - closure to execute when data becomes available. The closure should take at most one argument.
  - public Promise<V> then(Pool pool, groovy.lang.Closure<V> closure)
    
    Schedule closure to be executed after data becomes available. It is important to notice that even if the expression is already bound the execution of closure will not happen immediately but will be scheduled.
    Returns:
    A promise for the results of the supplied closure. This allows for chaining of then() method calls.
    Parameters:
    pool - The thread pool to use for task scheduling for asynchronous message delivery
    closure - closure to execute when data becomes available. The closure should take at most one argument.
  - public Promise<V> then(PGroup group, groovy.lang.Closure<V> closure)
    
    Schedule closure to be executed after data becomes available. It is important to notice that even if the expression is already bound the execution of closure will not happen immediately but will be scheduled.
    Returns:
    A promise for the results of the supplied closure. This allows for chaining of then() method calls.
    Parameters:
    group - The PGroup to use for task scheduling for asynchronous message delivery
    closure - closure to execute when data becomes available. The closure should take at most one argument.
  - public Promise<V> then(groovy.lang.Closure<V> closure, groovy.lang.Closure<V> errorHandler)
    
    Schedule closure to be executed after data became available. It is important to notice that even if the expression is already bound the execution of closure will not happen immediately but will be scheduled
    Returns:
    A promise for the results of the supplied closure. This allows for chaining of then() method calls.
    Parameters:
    closure - closure to execute when data becomes available. The closure should take at most one argument.
    errorHandler - closure to execute when an error (instance of Throwable) gets bound. The closure should take at most one argument.
  - public Promise<V> then(Pool pool, groovy.lang.Closure<V> closure, groovy.lang.Closure<V> errorHandler)
    
    Schedule closure to be executed after data becomes available. It is important to notice that even if the expression is already bound the execution of closure will not happen immediately but will be scheduled.
    Returns:
    A promise for the results of the supplied closure. This allows for chaining of then() method calls.
    Parameters:
    pool - The thread pool to use for task scheduling for asynchronous message delivery
    closure - closure to execute when data becomes available. The closure should take at most one argument.
    errorHandler - closure to execute when an error (instance of Throwable) gets bound. The closure should take at most one argument.
  - public Promise<V> then(PGroup group, groovy.lang.Closure<V> closure, groovy.lang.Closure<V> errorHandler)
    
    Schedule closure to be executed after data becomes available. It is important to notice that even if the expression is already bound the execution of closure will not happen immediately but will be scheduled.
    Returns:
    A promise for the results of the supplied closure. This allows for chaining of then() method calls.
    Parameters:
    group - The PGroup to use for task scheduling for asynchronous message delivery
    closure - closure to execute when data becomes available. The closure should take at most one argument.
    errorHandler - closure to execute when an error (instance of Throwable) gets bound. The closure should take at most one argument.
  - public Promise<java.util.List> thenForkAndJoin(groovy.lang.Closure<? extends java.lang.Object>... closures)
    
    Schedule a set of closures to be executed after data became available on the current promise. It is important to notice that even if the expression is already bound the execution of closures will not happen immediately, but will be scheduled. The returned Promise will hold a list of results of the individual closures, ordered in the same order. In case of an exception being thrown from any of the closures, the first exception gets propagated into the promise returned from the method.
    Returns:
    A promise for the results of the supplied closures. This allows for chaining of then() method calls.
    Parameters:
    closures - closure to execute when data becomes available. The closure should take at most one argument.
  - public Promise<java.util.List> thenForkAndJoin(Pool pool, groovy.lang.Closure<? extends java.lang.Object>... closures)
    
    Schedule a set of closures to be executed after data became available on the current promise. It is important to notice that even if the expression is already bound the execution of closures will not happen immediately, but will be scheduled. The returned Promise will hold a list of results of the individual closures, ordered in the same order. In case of an exception being thrown from any of the closures, the first exception gets propagated into the promise returned from the method.
    Returns:
    A promise for the results of the supplied closures. This allows for chaining of then() method calls.
    Parameters:
    pool - The thread pool to use for task scheduling for asynchronous message delivery
    closures - closure to execute when data becomes available. The closure should take at most one argument.
  - public Promise<java.util.List> thenForkAndJoin(PGroup group, groovy.lang.Closure<? extends java.lang.Object>... closures)
    
    Schedule a set of closures to be executed after data became available on the current promise. It is important to notice that even if the expression is already bound the execution of closures will not happen immediately, but will be scheduled. The returned Promise will hold a list of results of the individual closures, ordered in the same order. In case of an exception being thrown from any of the closures, the first exception gets propagated into the promise returned from the method.
    Returns:
    A promise for the results of the supplied closures. This allows for chaining of then() method calls.
    Parameters:
    group - The PGroup to use for task scheduling for asynchronous message delivery
    closures - closure to execute when data becomes available. The closure should take at most one argument.
  - public void touch()
    
    May be used by lazy implementations to warm up
  - public void whenBound(groovy.lang.Closure<V> closure)
    
    Schedule closure to be executed after data becomes available. It is important to notice that even if the expression is already bound the execution of closure will not happen immediately but will be scheduled.
    Parameters:
    closure - closure to execute when data becomes available. The closure should take at most one argument.
  - public void whenBound(Pool pool, groovy.lang.Closure<V> closure)
    
    Schedule closure to be executed after data becomes available. It is important to notice that even if the expression is already bound the execution of closure will not happen immediately but will be scheduled.
    Parameters:
    pool - The thread pool to use for task scheduling for asynchronous message delivery
    closure - closure to execute when data becomes available. The closure should take at most one argument.
  - public void whenBound(PGroup group, groovy.lang.Closure<V> closure)
    
    Schedule closure to be executed after data becomes available. It is important to notice that even if the expression is already bound the execution of closure will not happen immediately but will be scheduled.
    Parameters:
    group - The PGroup to use for task scheduling for asynchronous message delivery
    closure - closure to execute when data becomes available. The closure should take at most one argument.
  - public void whenBound(MessageStream stream)
    
    Send the bound data to provided stream when it becomes available
    Parameters:
    stream - stream where to send result

Summary:
Method

| Detail:
Method

[Java] Interface Promise<T>

Methods Summary

Inherited Methods Summary

Method Detail

@java.lang.SuppressWarnings({"ProhibitedExceptionDeclared"}) public T get()

@java.lang.SuppressWarnings({"ProhibitedExceptionDeclared"}) public T get(long timeout, java.util.concurrent.TimeUnit units)

public java.lang.Throwable getError()

public boolean isBound()

public boolean isError()

public void join()

public void join(long timeout, java.util.concurrent.TimeUnit units)

public Promise<V> rightShift(groovy.lang.Closure<V> closure)

public Promise<V> then(groovy.lang.Closure<V> closure)

public Promise<V> then(Pool pool, groovy.lang.Closure<V> closure)

public Promise<V> then(PGroup group, groovy.lang.Closure<V> closure)

public Promise<V> then(groovy.lang.Closure<V> closure, groovy.lang.Closure<V> errorHandler)

public Promise<V> then(Pool pool, groovy.lang.Closure<V> closure, groovy.lang.Closure<V> errorHandler)

public Promise<V> then(PGroup group, groovy.lang.Closure<V> closure, groovy.lang.Closure<V> errorHandler)

public Promise<java.util.List> thenForkAndJoin(groovy.lang.Closure<? extends java.lang.Object>... closures)

public Promise<java.util.List> thenForkAndJoin(Pool pool, groovy.lang.Closure<? extends java.lang.Object>... closures)

public Promise<java.util.List> thenForkAndJoin(PGroup group, groovy.lang.Closure<? extends java.lang.Object>... closures)

public void touch()

public void whenBound(groovy.lang.Closure<V> closure)

public void whenBound(Pool pool, groovy.lang.Closure<V> closure)

public void whenBound(PGroup group, groovy.lang.Closure<V> closure)

public void whenBound(MessageStream stream)