Class BulkGetFuture<T>

java.lang.Object

net.spy.memcached.compat.SpyObject

net.spy.memcached.internal.AbstractListenableFuture<Map<String,T>, BulkGetCompletionListener>

net.spy.memcached.internal.BulkGetFuture<T>

Type Parameters:

T - types of objects returned from the GET

All Implemented Interfaces:

Future<Map<String,T>>, BulkFuture<Map<String,T>>, ListenableFuture<Map<String,T>, BulkGetCompletionListener>

public class BulkGetFuture<T>
extends AbstractListenableFuture<Map<String,T>, BulkGetCompletionListener>
implements BulkFuture<Map<String,T>>

Future for handling results from bulk gets. Not intended for general use.

Nested Class Summary

Nested classes/interfaces inherited from interface Future

Future.State

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	cancelled
private final CountDownLatch	latch
private final Collection<Operation>	ops
private final Map<String, Future<T>>	rvMap
private OperationStatus	status
private boolean	timeout

Constructor Summary

Constructors

Constructor	Description
BulkGetFuture(Map<String, Future<T>> m, Collection<Operation> getOps, CountDownLatch l, ExecutorService service)

Method Summary

Modifier and Type	Method	Description
Future<Map<String,T>>	addListener(BulkGetCompletionListener listener)	Add a listener to the future, which will be executed once the operation completes.
boolean	cancel(boolean ign)
Map<String,T>	get()
Map<String,T>	get(long to, TimeUnit unit)
Map<String,T>	getSome(long to, TimeUnit unit)	Wait for the operation to complete and return results If operation could not complete within specified timeout, partial result is returned.
OperationStatus	getStatus()	Gets the status of the operation upon completion.
private Map<String,T>	internalGet(long to, TimeUnit unit, Collection<Operation> timedoutOps)	refactored code common to both get(long, TimeUnit) and getSome(long, TimeUnit).
boolean	isCancelled()
boolean	isDone()
boolean	isTimeout()
Future<Map<String,T>>	removeListener(BulkGetCompletionListener listener)	Remove a previously added listener from the future.
void	setStatus(OperationStatus s)
void	signalComplete()	Signals that this future is complete.

Methods inherited from class AbstractListenableFuture

addToListeners, executor, notifyListener, notifyListeners, notifyListeners, removeFromListeners

Methods inherited from class SpyObject

getLogger

Methods inherited from class Object

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

Methods inherited from interface Future

exceptionNow, resultNow, state

Field Details

rvMap

private final Map<String, Future<T>> rvMap

ops

private final Collection<Operation> ops

latch

private final CountDownLatch latch

status

private OperationStatus status

cancelled

private boolean cancelled

timeout

private boolean timeout

Constructor Details

BulkGetFuture

public BulkGetFuture(Map<String, Future<T>> m,
 Collection<Operation> getOps,
 CountDownLatch l,
 ExecutorService service)

Method Details

cancel

public boolean cancel(boolean ign)

Specified by:

cancel in interface Future<T>

get

public Map<String,T> get()
                  throws InterruptedException,
ExecutionException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

getSome

public Map<String,T> getSome(long to,
 TimeUnit unit)
                      throws InterruptedException,
ExecutionException

Description copied from interface: BulkFuture

Wait for the operation to complete and return results If operation could not complete within specified timeout, partial result is returned. Otherwise, the behavior is identical to Future.get(long, TimeUnit)

Specified by:

getSome in interface BulkFuture<T>

Parameters:

to -

unit -

Returns:

a partial get bulk result

Throws:

InterruptedException

ExecutionException

get

public Map<String,T> get(long to,
 TimeUnit unit)
                  throws InterruptedException,
ExecutionException,
TimeoutException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

TimeoutException

internalGet

private Map<String,T> internalGet(long to,
 TimeUnit unit,
 Collection<Operation> timedoutOps)
                           throws InterruptedException,
ExecutionException

refactored code common to both get(long, TimeUnit) and getSome(long, TimeUnit).

Parameters:

to -

unit -

timedoutOps -

Returns:

Throws:

InterruptedException

ExecutionException

getStatus

public OperationStatus getStatus()

Description copied from interface: BulkFuture

Gets the status of the operation upon completion.

Specified by:

getStatus in interface BulkFuture<T>

Returns:

the operation status.

setStatus

public void setStatus(OperationStatus s)

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<T>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<T>

isTimeout

public boolean isTimeout()

Specified by:

isTimeout in interface BulkFuture<T>

Returns:

true if timeout was reached, false otherwise

addListener

public Future<Map<String,T>> addListener(BulkGetCompletionListener listener)

Description copied from interface: ListenableFuture

Add a listener to the future, which will be executed once the operation completes.

Specified by:

addListener in interface BulkFuture<T>

Specified by:

addListener in interface ListenableFuture<Map<String,T>, BulkGetCompletionListener>

Parameters:

listener - the listener which will be executed.

Returns:

the current future to allow for object-chaining.

removeListener

public Future<Map<String,T>> removeListener(BulkGetCompletionListener listener)

Description copied from interface: ListenableFuture

Remove a previously added listener from the future.

Specified by:

removeListener in interface BulkFuture<T>

Specified by:

removeListener in interface ListenableFuture<Map<String,T>, BulkGetCompletionListener>

Parameters:

listener - the previously added listener.

Returns:

the current future to allow for object-chaining.

signalComplete

public void signalComplete()

Signals that this future is complete.