javax.cache.event

Class CompletionListenerFuture

java.lang.Object

javax.cache.event.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 java.lang.IllegalStateException being raised.

Author:

Brian Oliver

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()
Void	get(long l, TimeUnit timeUnit)
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()

Description copied from interface: CompletionListener

Notifies the application that the operation completed successfully.

Specified by:

onCompletion in interface CompletionListener

onException

public void onException(Exception e)

Description copied from interface: CompletionListener

Notifies the application that the operation failed.

Specified by:

onException in interface CompletionListener

Parameters:

e - the Exception that occurred

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

Specified by:

get in interface Future<Void>

Throws:

InterruptedException

ExecutionException

get

public Void get(long l,
       TimeUnit timeUnit)
         throws InterruptedException,
                ExecutionException,
                TimeoutException

Specified by:

get in interface Future<Void>

Throws:

InterruptedException

ExecutionException

TimeoutException