org.apache.hadoop.fs.s3a.impl

Class CallableSupplier<T>

java.lang.Object

org.apache.hadoop.fs.s3a.impl.CallableSupplier<T>

Type Parameters:

T - return type.

All Implemented Interfaces:

Supplier<T>

public final class CallableSupplier<T>
extends Object
implements Supplier<T>

A bridge from Callable to Supplier; catching exceptions raised by the callable and wrapping them as appropriate.

Constructor Summary

Constructors

Constructor and Description
CallableSupplier(org.apache.hadoop.fs.store.audit.AuditSpan auditSpan, Callable<T> call) Create.
CallableSupplier(Callable<T> call) Create.

Method Summary

Modifier and Type	Method and Description
T	get() Active any span and then call the supplied callable.
static <T> Optional<T>	maybeAwaitCompletion(CompletableFuture<T> future) Block awaiting completion for any non-null future passed in; No-op if a null arg was supplied.
static <T> CompletableFuture<T>	submit(Executor executor, org.apache.hadoop.fs.store.audit.AuditSpan auditSpan, Callable<T> call) Submit a callable into a completable future.
static <T> CompletableFuture<T>	submit(Executor executor, Callable<T> call) Submit a callable into a completable future.
static <T> T	waitForCompletion(CompletableFuture<T> future) Wait for a single of future to complete, extracting IOEs afterwards.
static <T> void	waitForCompletion(List<CompletableFuture<T>> futures) Wait for a list of futures to complete.
static <T> Optional<T>	waitForCompletionIgnoringExceptions(CompletableFuture<T> future) Wait for a single of future to complete, ignoring exceptions raised.

Methods inherited from class java.lang.Object

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

Constructor Detail

CallableSupplier

public CallableSupplier(Callable<T> call)

Create.

Parameters:

call - call to invoke.

CallableSupplier

public CallableSupplier(org.apache.hadoop.fs.store.audit.AuditSpan auditSpan,
                        Callable<T> call)

Create.

Parameters:

auditSpan - audit span (or null)

call - call to invoke.

Method Detail

get

public T get()

Active any span and then call the supplied callable.

Specified by:

get in interface Supplier<T>

Returns:

the result.

submit

public static <T> CompletableFuture<T> submit(Executor executor,
                                              Callable<T> call)

Submit a callable into a completable future. RTEs are rethrown. Non RTEs are caught and wrapped; IOExceptions to RuntimeIOException instances.

Type Parameters:

T - type

Parameters:

executor - executor.

call - call to invoke

Returns:

the future to wait for

submit

public static <T> CompletableFuture<T> submit(Executor executor,
                                              org.apache.hadoop.fs.store.audit.AuditSpan auditSpan,
                                              Callable<T> call)

Submit a callable into a completable future. RTEs are rethrown. Non RTEs are caught and wrapped; IOExceptions to RuntimeIOException instances.

Type Parameters:

T - type

Parameters:

executor - executor.

auditSpan - audit span (or null)

call - call to invoke

Returns:

the future to wait for

waitForCompletion

public static <T> void waitForCompletion(List<CompletableFuture<T>> futures)
                                  throws IOException

Wait for a list of futures to complete. If the list is empty, return immediately.

Type Parameters:

T - type

Parameters:

futures - list of futures.

Throws:

IOException - if one of the called futures raised an IOE.

RuntimeException - if one of the futures raised one.

waitForCompletion

public static <T> T waitForCompletion(CompletableFuture<T> future)
                               throws IOException

Wait for a single of future to complete, extracting IOEs afterwards.

Type Parameters:

T - type

Parameters:

future - future to wait for.

Returns:

the result

Throws:

IOException - if one of the called futures raised an IOE.

RuntimeException - if one of the futures raised one.

waitForCompletionIgnoringExceptions

public static <T> Optional<T> waitForCompletionIgnoringExceptions(@Nullable
                                                                  CompletableFuture<T> future)

Wait for a single of future to complete, ignoring exceptions raised.

Type Parameters:

T - type

Parameters:

future - future to wait for.

Returns:

the outcome if successfully retrieved.

maybeAwaitCompletion

public static <T> Optional<T> maybeAwaitCompletion(@Nullable
                                                   CompletableFuture<T> future)
                                            throws IOException

Block awaiting completion for any non-null future passed in; No-op if a null arg was supplied.

Type Parameters:

T - return type

Parameters:

future - future

Returns:

the outcome; is empty if the future was null/had no return value

Throws:

IOException - if one of the called futures raised an IOE.

RuntimeException - if one of the futures raised one.