com.amazonaws.internal

Class ReturningRunnable<R>

java.lang.Object

com.amazonaws.internal.ReturningRunnable<R>

Type Parameters:

R - the type of the result/return

public abstract class ReturningRunnable<R>
extends java.lang.Object

Internal class to allow easy surfacing of synchronous and asynchronous operations. This class may change without notice and may not be reflected in the SDK versioning scheme.

Constructor Summary

Constructors

Constructor and Description
ReturningRunnable() Default constructor.
ReturningRunnable(java.lang.String operationDescription) When an exception is thrown, it will be wrapped with another exception with a message specified by operationDescription.

Method Summary

Modifier and Type	Method and Description
void	async(Callback<R> callback) Runs the code inside run() on a new Thread asynchronously and returns immediately.
R	await() Runs the code inside run() synchronously on the same thread this method is called.
abstract R	run() This method contains the underlying operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReturningRunnable

public ReturningRunnable()

Default constructor. When an exception is thrown, it will not be wrapped with another exception.

ReturningRunnable

public ReturningRunnable(java.lang.String operationDescription)

When an exception is thrown, it will be wrapped with another exception with a message specified by operationDescription.

Parameters:

operationDescription - The message of the exception that wraps the underlying exception.

Method Detail

run

public abstract R run()
               throws java.lang.Exception

This method contains the underlying operation.

Returns:

Any result object of type R

Throws:

java.lang.Exception - Any error from performing the underlying operation

await

public R await()
        throws java.lang.Exception

Runs the code inside run() synchronously on the same thread this method is called.

Returns:

the result from the run() method

Throws:

java.lang.Exception - error from the operation

async

public void async(Callback<R> callback)

Runs the code inside run() on a new Thread asynchronously and returns immediately.

Parameters:

callback - receives the result or error from the operation