Package org.apache.hadoop.util.concurrent

Interface AsyncGet<R,E extends java.lang.Throwable>

Type Parameters:

R - The type of the return value.

E - The exception type that the underlying implementation may throw.

public interface AsyncGet<R,E extends java.lang.Throwable>

This interface defines an asynchronous get(long, TimeUnit) method. When the return value is still being computed, invoking get(long, TimeUnit) will result in a TimeoutException. The method should be invoked again and again until the underlying computation is completed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AsyncGet.Util	Utility

Method Summary

Modifier and Type	Method	Description
R	get(long timeout, java.util.concurrent.TimeUnit unit)	Get the result.
boolean	isDone()

Method Detail

get

R get(long timeout,
      java.util.concurrent.TimeUnit unit)
throws E extends java.lang.Throwable,
      java.util.concurrent.TimeoutException,
      java.lang.InterruptedException

Get the result.

Parameters:

timeout - The maximum time period to wait. When timeout == 0, it does not wait at all. When timeout < 0, it waits indefinitely.

unit - The unit of the timeout value

Returns:

the result, which is possibly null.

Throws:

E - an exception thrown by the underlying implementation.

java.util.concurrent.TimeoutException - if it cannot return after the given time period.

java.lang.InterruptedException - if the thread is interrupted.

E extends java.lang.Throwable

isDone

boolean isDone()

Returns:

true if the underlying computation is done; false, otherwise.