com.googlecode.objectify.cache

Class MergeFuture<K,V>

java.lang.Object

com.googlecode.objectify.cache.MergeFuture<K,V>

All Implemented Interfaces:

Future<Map<K,V>>

public class MergeFuture<K,V>
extends Object
implements Future<Map<K,V>>

A Future which merges some previously loaded values with the results of another Future that is in progress. It can apply to any key/value pair type; typically it will be for Key/Entity or Key/T

Author:

Jeff Schnitzer

Constructor Summary

Constructors

Constructor and Description
MergeFuture(Map<K,V> preloaded, Future<Map<K,V>> pending)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
Map<K,V>	get()
Map<K,V>	get(long timeout, TimeUnit unit)
boolean	isCancelled()
boolean	isDone()

Methods inherited from class java.lang.Object

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

Constructor Detail

MergeFuture

public MergeFuture(Map<K,V> preloaded,
           Future<Map<K,V>> pending)

Parameters:

preloaded - is a collection of entities that have already been obtained, say from the memcache. TAKES OWNERSHIP OF THE MAP OBJECT - it will be modified later.

pending - is a future of entities that will be obtained sometime later, or null if merging is unnecessary and the preloaded values complete the result.

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<Map<K,V>>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<Map<K,V>>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<Map<K,V>>

See Also:

Future.isDone()

get

public Map<K,V> get()
             throws InterruptedException,
                    ExecutionException

Specified by:

get in interface Future<Map<K,V>>

Throws:

InterruptedException

ExecutionException

get

public Map<K,V> get(long timeout,
           TimeUnit unit)
             throws InterruptedException,
                    ExecutionException,
                    TimeoutException

Specified by:

get in interface Future<Map<K,V>>

Throws:

InterruptedException

ExecutionException

TimeoutException