CachedResponseFuture (net.toddm:CommFramework 1.0.2 API)

java.lang.Object
- java.util.concurrent.FutureTask<Response>
- - net.toddm.comm.CachedResponseFuture

All Implemented Interfaces:

Runnable, Future<Response>, RunnableFuture<Response>
```
public class CachedResponseFuture
extends FutureTask<Response>
```
This is a simple no-op FutureTask implementation that simply wraps and returns a cached Response. We provide this wrapping so that no special case code is ever required. Client code can still be written to, for example, block on future get() wait handles. In this case of cached results this will simply return the cached result immediately.

Author:

Todd S. Murchison

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`CachedResponseFuture(Response cachedResponse)`	Constructors a `FutureTask` instance that always immediately returns the given Response.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Response`	`get()`	Immediately returns the cached `Response`.
`Response`	`get(long timeout, TimeUnit unit)`	Immediately returns the cached `Response`.
`boolean`	`isCancelled()`	Always returns FALSE.
`boolean`	`isDone()`	Always returns TRUE.
`void`	`run()`	Does nothing.

Methods inherited from class java.util.concurrent.FutureTask
cancel, done, runAndReset, set, setException, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CachedResponseFuture
```
protected CachedResponseFuture(Response cachedResponse)
```
    Constructors a FutureTask instance that always immediately returns the given Response.
- Method Detail
  - get
```
public Response get()
```
    Immediately returns the cached Response.
    
    Specified by:
    
    get in interface Future<Response>
    
    Overrides:
    
    get in class FutureTask<Response>
  - get
```
public Response get(long timeout,
                    TimeUnit unit)
```
    Immediately returns the cached Response.
    
    Specified by:
    
    get in interface Future<Response>
    
    Overrides:
    
    get in class FutureTask<Response>
  - isCancelled
```
public boolean isCancelled()
```
    Always returns FALSE.
    
    Specified by:
    
    isCancelled in interface Future<Response>
    
    Overrides:
    
    isCancelled in class FutureTask<Response>
  - isDone
```
public boolean isDone()
```
    Always returns TRUE.
    
    Specified by:
    
    isDone in interface Future<Response>
    
    Overrides:
    
    isDone in class FutureTask<Response>
  - run
```
public void run()
```
    Does nothing.
    
    Specified by:
    
    run in interface Runnable
    
    Specified by:
    
    run in interface RunnableFuture<Response>
    
    Overrides:
    
    run in class FutureTask<Response>