javax.cache.integration

Class CompletionListenerFuture

java.lang.Object

javax.cache.integration.CompletionListenerFuture

All Implemented Interfaces:

Future<Void>, CompletionListener

public class CompletionListenerFuture
extends Object
implements CompletionListener, Future<Void>

A CompletionListenerFuture is a CompletionListener implementation that supports being used as a Future.

For example:

 //create a completion future to use to wait for loadAll
 CompletionListenerFuture future = new CompletionListenerFuture();
 
 //load the values for the set of keys, replacing those that may already exist
 //in the cache
 cache.loadAll(keys, true, future);
 
 //wait for the cache to load the keys
 future.get();
 

A CompletionListenerFuture may only be used once. Attempts to use an instance multiple times, as part of multiple asynchronous calls will result in an IllegalStateException being raised.

Since:

1.0

Author:

Brian Oliver, Greg Luck

Constructor Summary

Constructors

Constructor and Description
CompletionListenerFuture() Constructs a CompletionListenerFuture.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel(boolean b)
Void	get() Waits if necessary for the computation to complete, and then retrieves its result.
Void	get(long timeout, TimeUnit unit) Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
boolean	isCancelled()
boolean	isDone()
void	onCompletion() Notifies the application that the operation completed successfully.
void	onException(Exception e) Notifies the application that the operation failed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompletionListenerFuture

public CompletionListenerFuture()

Constructs a CompletionListenerFuture.

Method Detail

onCompletion

public void onCompletion()
                  throws IllegalStateException

Notifies the application that the operation completed successfully.

Specified by:

onCompletion in interface CompletionListener

Throws:

IllegalStateException - if the instance is used more than once

onException

public void onException(Exception e)
                 throws IllegalStateException

Notifies the application that the operation failed.

Specified by:

onException in interface CompletionListener

Parameters:

e - the Exception that occurred

Throws:

IllegalStateException - if the instance is used more than once

cancel

public boolean cancel(boolean b)

Specified by:

cancel in interface Future<Void>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<Void>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<Void>

get

public Void get()
         throws InterruptedException,
                ExecutionException

Waits if necessary for the computation to complete, and then retrieves its result.

Specified by:

get in interface Future<Void>

Returns:

the computed result

Throws:

CancellationException - if the computation was cancelled

ExecutionException - if the computation threw an exception. This wraps the exception received by (Exception)

InterruptedException - if the current thread was interrupted while waiting

get

public Void get(long timeout,
       TimeUnit unit)
         throws InterruptedException,
                ExecutionException,
                TimeoutException

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Specified by:

get in interface Future<Void>

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

the computed result

Throws:

CancellationException - if the computation was cancelled

ExecutionException - if the computation threw an exception. This wraps the exception received by (Exception)

InterruptedException - if the current thread was interrupted while waiting

TimeoutException - if the wait timed out