com.chemaxon.overlap.service.async

Class AsyncCall<R>

java.lang.Object

com.chemaxon.overlap.service.async.AsyncCall<R>

Type Parameters:

R - result type

public class AsyncCall<R>
extends Object

Represents an async call from rest with an id.

Constructor Summary

Constructors

Constructor and Description
AsyncCall(String id, ExecutableTask<R> task, Future<R> future)

Method Summary

Modifier and Type	Method and Description
void	awaitCompletion(Long timeoutMs) Waits if necessary for at most the given time for the call to complete.
R	awaitCompletionAndGetResult() Waits if necessary for at most the given time for the call to complete and returns it's result.
R	awaitCompletionAndGetResult(Long completionTimeoutMs) Waits if necessary for at most the given time for the call to complete, and then retrieves its result, if available.
String	getId()
R	getResultOrNull() Gets the result if the call has been completed or null if not.
ExecutableTask<R>	getTask()

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncCall

public AsyncCall(String id,
                 ExecutableTask<R> task,
                 Future<R> future)

Method Detail

getId

public String getId()

getTask

public ExecutableTask<R> getTask()

getResultOrNull

public R getResultOrNull()

Gets the result if the call has been completed or null if not.

Returns:

result or null if not completed yet.

Throws:

RuntimeException - if the computation threw an unchecked exception (direct type will be thrown)

UncheckedExecutionException - if the computation threw a checked exception (wrapped)

awaitCompletion

public void awaitCompletion(Long timeoutMs)

Waits if necessary for at most the given time for the call to complete.

- If call has been canceled or thrown an exception while waiting, this method returns immediately.
- Thrown exceptions not propagated by this method.

Parameters:

timeoutMs - the maximum time in millis to wait
- if null then waiting infinitely

awaitCompletionAndGetResult

public R awaitCompletionAndGetResult()

Waits if necessary for at most the given time for the call to complete and returns it's result.

- If call has been canceled or thrown an exception while waiting, this method returns immediately.

Throws:

RuntimeException - if the computation threw an unchecked exception (direct type will be thrown)

UncheckedExecutionException - if the computation threw a checked exception (wrapped)

awaitCompletionAndGetResult

public R awaitCompletionAndGetResult(Long completionTimeoutMs)

Waits if necessary for at most the given time for the call to complete, and then retrieves its result, if available.

Parameters:

completionTimeoutMs - the maximum time in millis to wait
- if null then waiting infinitely

Throws:

RuntimeException - if the computation threw an unchecked exception (direct type will be thrown)

UncheckedExecutionException - if the computation threw a checked exception (wrapped)