org.infinispan.commons.util.concurrent

Class NoOpFuture<E>

java.lang.Object

org.infinispan.commons.util.concurrent.NoOpFuture<E>

All Implemented Interfaces:

java.util.concurrent.Future<E>, NotifyingFuture<E>, NotifyingNotifiableFuture<E>

public class NoOpFuture<E>
extends java.lang.Object
implements NotifyingNotifiableFuture<E>

A future that doesn't do anything and simply returns a given return value.

Since:

5.1

Author:

Manik Surtani

Field Summary

Fields

Modifier and Type	Field and Description
private E	returnValue

Constructor Summary

Constructors

Constructor and Description
NoOpFuture(E returnValue)

Method Summary

Methods

Modifier and Type	Method and Description
NotifyingFuture<E>	attachListener(FutureListener<E> eFutureListener) Attaches a listener and returns the same future instance, to allow for 'building'.
boolean	cancel(boolean b)
E	get()
E	get(long l, java.util.concurrent.TimeUnit timeUnit)
boolean	isCancelled()
boolean	isDone()
void	notifyDone(E result) Notify the listeners that the operation has finished.
void	notifyException(java.lang.Throwable exception) Notify the listeners that the operation has finished.
void	setFuture(java.util.concurrent.Future<E> eFuture) Setup the future which is wrapped by implementation of this interface.

Methods inherited from class java.lang.Object

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

Field Detail

returnValue

private final E returnValue

Constructor Detail

NoOpFuture

public NoOpFuture(E returnValue)

Method Detail

cancel

public boolean cancel(boolean b)

Specified by:

cancel in interface java.util.concurrent.Future<E>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<E>

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<E>

get

public E get()
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException

Specified by:

get in interface java.util.concurrent.Future<E>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

public E get(long l,
    java.util.concurrent.TimeUnit timeUnit)
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException,
             java.util.concurrent.TimeoutException

Specified by:

get in interface java.util.concurrent.Future<E>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

notifyDone

public void notifyDone(E result)

Description copied from interface: NotifyingNotifiableFuture

Notify the listeners that the operation has finished. Subsequent calls for isDone() will return true and subsequent calls for get() will return the provided result.

Specified by:

notifyDone in interface NotifyingNotifiableFuture<E>

notifyException

public void notifyException(java.lang.Throwable exception)

Description copied from interface: NotifyingNotifiableFuture

Notify the listeners that the operation has finished. Subsequent calls for isDone() will return true and subsequent calls for get() will throw the provided exception.

Specified by:

notifyException in interface NotifyingNotifiableFuture<E>

setFuture

public void setFuture(java.util.concurrent.Future<E> eFuture)

Description copied from interface: NotifyingNotifiableFuture

Setup the future which is wrapped by implementation of this interface. Warning: the implementation must synchronize the call setFuture() and notifyDone() to be executed in this order. Also, all calls delegated to the future must be deferred until the network future is set up.

Specified by:

setFuture in interface NotifyingNotifiableFuture<E>

attachListener

public NotifyingFuture<E> attachListener(FutureListener<E> eFutureListener)

Description copied from interface: NotifyingFuture

Attaches a listener and returns the same future instance, to allow for 'building'.

Specified by:

attachListener in interface NotifyingFuture<E>

Parameters:

eFutureListener - listener to attach

Returns:

the same future instance