de.fhg.fokus.xtensions.concurrent

Class AsyncCompute

java.lang.Object

de.fhg.fokus.xtensions.concurrent.AsyncCompute

public final class AsyncCompute
extends Object

The static methods of this class start asynchronous computation, such as the asyncSupply, and asyncRun methods.

Method Summary

Modifier and Type	Method and Description
static CompletableFuture<?>	asyncRun(Executor executor, long timeout, TimeUnit unit, Procedures.Procedure1<? super CompletableFuture<?>> runAsync) This method will create a CompletableFuture and will run the given runAsync procedure asynchronously, by calling it on the given executor, passing the created future to it.
static CompletableFuture<?>	asyncRun(Executor executor, Procedures.Procedure1<? super CompletableFuture<?>> runAsync) This method will create a CompletableFuture and will run the given runAsync procedure asynchronously, by calling it on the given executor, passing the created future to it.
static CompletableFuture<?>	asyncRun(Executor executor, ScheduledExecutorService scheduler, long timeout, TimeUnit unit, Procedures.Procedure1<? super CompletableFuture<?>> runAsync) This method will create a CompletableFuture and will run the given runAsync procedure asynchronously, by calling it on the given executor, passing the created future to it.
static CompletableFuture<?>	asyncRun(long timeout, TimeUnit unit, Procedures.Procedure1<? super CompletableFuture<?>> runAsync) Calls asyncRun(Executor,long,TimeUnit,(CompletableFuture<?>)=>void) with the common ForkJoinPool as the executor.
static CompletableFuture<?>	asyncRun(Procedures.Procedure1<? super CompletableFuture<?>> runAsync) Calls asyncRun(Executor,(CompletableFuture<?>)=>void) with the common ForkJoinPool as the executor.
static <R> CompletableFuture<R>	asyncSupply(Executor executor, Functions.Function1<? super CompletableFuture<?>,? extends R> runAsync) This method will call the given runAsync function using the provided executor.
static <R> CompletableFuture<R>	asyncSupply(Executor executor, long timeout, TimeUnit unit, Functions.Function1<? super CompletableFuture<?>,? extends R> runAsync) This method will call the given runAsync function using the given executor.
static <R> CompletableFuture<R>	asyncSupply(Executor executor, ScheduledExecutorService scheduler, long timeout, TimeUnit unit, Functions.Function1<? super CompletableFuture<?>,? extends R> runAsync) This method will call the given runAsync function using the given executor.
static <R> CompletableFuture<R>	asyncSupply(Functions.Function1<? super CompletableFuture<?>,? extends R> runAsync) This method will call the given runAsync function using the common ForkJoinPool passing in a new CompletableFuture which is also being returned from this method.
static <R> CompletableFuture<R>	asyncSupply(long timeout, TimeUnit unit, Functions.Function1<? super CompletableFuture<?>,? extends R> runAsync) This method will call the given runAsync function using the common ForkJoinPool with the CompletableFuture being returned.
static <R> CompletableFuture<R>	asyncSupply(ScheduledExecutorService scheduler, long timeout, TimeUnit unit, Functions.Function1<? super CompletableFuture<?>,? extends R> runAsync) This method will call the given runAsync function using the common ForkJoinPool with the CompletableFuture being returned.

Methods inherited from class java.lang.Object

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

Method Detail

asyncSupply

public static <R> CompletableFuture<R> asyncSupply(Functions.Function1<? super CompletableFuture<?>,? extends R> runAsync)

This method will call the given runAsync function using the common ForkJoinPool passing in a new CompletableFuture which is also being returned from this method. This future is supposed to be used to checked by the runAsync function for completion from the outside. The value returned by the runAsync function will be used to try to complete the returned future with. If runAsync throws a Throwable, it will be used to complete the future exceptionally with the thrown object. The result or exception from the runAsync method will not be obtruded to the future; if the future is completed from the outside before completion of runAsync, its result will be ignored.

Type Parameters:

R - Type of the object supplied by runAsync, and that is promised to be made available in the returned future.

Parameters:

runAsync - function to be executed on the common ForkJoinPool. The result of this function will be used to complete the CompletableFuture returned by this method.

Returns:

future that will used to provide result from concurrently executed runAsync. This future may be cancelled by the user, the runAsync function is advised to check the future for completion.

Throws:

NullPointerException - if runAsync is null

asyncSupply

public static <R> CompletableFuture<R> asyncSupply(Executor executor,
                                                   Functions.Function1<? super CompletableFuture<?>,? extends R> runAsync)

This method will call the given runAsync function using the provided executor. A new CompletableFuture will be passed to runAsync and returned by this method. This parameter is supposed to be used by the runAsync function to check for completion from the outside. The value returned by the runAsync function will be used to try to complete the returned future with. If runAsync throws a Throwable, it will be used to try to complete the future exceptionally with the thrown object. The result or exception from the runAsync method will not be obtruded to the future; if the future is completed from the outside before completion of runAsync, its result will be ignored.

Type Parameters:

R - Type of the object supplied by runAsync, and that is promised to be made available in the returned future.

Parameters:

executor - the executor used to execute runAsync concurrently.

runAsync - function to be executed using the provided executor.

Returns:

future that will used to provide result from concurrently executed runAsync. This future may be cancelled by the user, the runAsync function is advised to check the future for completion.

Throws:

NullPointerException - if runAsync is null

asyncSupply

public static <R> CompletableFuture<R> asyncSupply(long timeout,
                                                   TimeUnit unit,
                                                   Functions.Function1<? super CompletableFuture<?>,? extends R> runAsync)

This method will call the given runAsync function using the common ForkJoinPool with the CompletableFuture being returned. This parameter is supposed to be used to checked by the runAsync function for cancellation/completion from the outside. The value returned by the runAsync function will be used to try to complete the returned future. If runAsync throws a Throwable, it will be used to complete the future exceptionally with the thrown object. If the runAsync function does not provide a result value after the timeout specified via the parameters timeout and unit, the returned future will be completed exceptionally with a TimoutException. Therefore the runAsync function is advised to check for completion of the future provided to it as parameter. If runAsync returns a value after the CompletableFuture was completed, the result will not appear in the CompletableFuture.

Type Parameters:

R - Type of the object supplied by runAsync, and that is promised to be made available in the returned future.

Parameters:

timeout - Amount of time after which the returned CompletableFuture is completed exceptionally, if it was not completed until then. The unit of the amount of time is specified via parameter unit.

unit - the time unit of the timeout parameter.

runAsync - function to be executed on the common ForkJoinPool. The result of this function will be used to complete the CompletableFuture returned by this method.

Returns:

future that will used to provide result from concurrently executed runAsync. This future may be cancelled by the user, the runAsync function is advised to check the future for completion.

Throws:

NullPointerException - if runAsync is null

asyncSupply

public static <R> CompletableFuture<R> asyncSupply(ScheduledExecutorService scheduler,
                                                   long timeout,
                                                   TimeUnit unit,
                                                   Functions.Function1<? super CompletableFuture<?>,? extends R> runAsync)

This method will call the given runAsync function using the common ForkJoinPool with the CompletableFuture being returned. This parameter is supposed to be used to checked by the runAsync function for completion/cancellation from the outside. The value returned by the runAsync function will be used to try to complete the returned future. If runAsync throws a Throwable, it will be used to complete the future exceptionally with the thrown object. If the runAsync function does not provide a result value after the timeout specified via the parameters timeout and unit, the returned future will be completed exceptionally with a new TimeoutException. For the scheduling of the timeout the given scheduler will be used. The scheduler will not be shut down after timeout. The runAsync function is advised to check for completion of the future provided to it as parameter. If runAsync returns a value after the CompletableFuture was cancelled or completed from the outside, the result will not appear in the CompletableFuture; the result will not be obtruted to the future.

Type Parameters:

R - Type of the object supplied by runAsync, and that is promised to be made available in the returned future.

Parameters:

scheduler - is the executor service used to schedule the exceptional completion after timeout specified via timeout and unit.

timeout - Amount of time after which the returned CompletableFuture is completed exceptionally, if it was not completed until then. The unit of the amount of time is specified via parameter unit.

unit - the time unit of the timeout parameter.

runAsync - function to be executed on the common ForkJoinPool. The result of this function will be used to complete the CompletableFuture returned by this method.

Returns:

future that will used to provide result from concurrently executed runAsync. This future may be cancelled by the user, the runAsync function is advised to check the future for cancellation/completion.

asyncSupply

public static <R> CompletableFuture<R> asyncSupply(Executor executor,
                                                   long timeout,
                                                   TimeUnit unit,
                                                   Functions.Function1<? super CompletableFuture<?>,? extends R> runAsync)

This method will call the given runAsync function using the given executor. being returned. This parameter is supposed to be used to checked by the runAsync function for completion from the outside. The value returned by the runAsync function will be used to try to complete the returned future. If runAsync throws a Throwable, it will be used to complete the future exceptionally with the thrown object. If the runAsync function does not provide a result value after the timeout specified via the parameters timeout and unit, the returned future will be completed exceptionally with a new TimeoutException. For the scheduling of the timeout the given scheduler will be used. The scheduler will not be shut down after timeout. The runAsync function is advised to check for completion of the future provided to it as parameter. If runAsync returns a value after the CompletableFuture was cancelled or completed from the outside, the result will not appear in the CompletableFuture; the result will not be obtruted to the future.

Type Parameters:

R - Type of the object supplied by runAsync, and that is promised to be made available in the returned future.

Parameters:

executor - is the executor used to run runAsync asynchronously.

timeout - Amount of time after which the returned CompletableFuture is completed exceptionally, if it was not completed until then. The unit of the amount of time is specified via parameter unit.

unit - the time unit of the timeout parameter.

runAsync - function to be executed on the common ForkJoinPool. The result of this function will be used to complete the CompletableFuture returned by this method.

Returns:

future that will used to provide result from concurrently executed runAsync. This future may be cancelled by the user, the runAsync function is advised to check the future for completion.

asyncSupply

public static <R> CompletableFuture<R> asyncSupply(Executor executor,
                                                   ScheduledExecutorService scheduler,
                                                   long timeout,
                                                   TimeUnit unit,
                                                   Functions.Function1<? super CompletableFuture<?>,? extends R> runAsync)

This method will call the given runAsync function using the given executor. being returned. This parameter is supposed to be used to checked by the runAsync function for completion from the outside. The value returned by the runAsync function will be used to try to complete the returned future. If runAsync throws a Throwable, it will be used to complete the future exceptionally with the thrown object. If the runAsync function does not provide a result value after the timeout specified via the parameters timeout and unit, the returned future will be completed exceptionally with a TimeoutException. Therefore the runAsync function is advised to check for completion of the future provided to it as parameter. If runAsync returns a value after the CompletableFuture was completed, the result will not appear in the CompletableFuture.

Type Parameters:

R - Type of the object supplied by runAsync, and that is promised to be made available in the returned future.

Parameters:

executor - is the executor used to run runAsync asynchronously.

scheduler - is the executor service used to schedule the exceptional completion after timeout specified via timeout and unit.

timeout - Amount of time after which the returned CompletableFuture is completed exceptionally, if it was not completed until then. The unit of the amount of time is specified via parameter unit.

unit - the time unit of the timeout parameter.

runAsync - function to be executed on the common ForkJoinPool. The result of this function will be used to complete the CompletableFuture returned by this method.

Returns:

future that will used to provide result from concurrently executed runAsync. This future may be cancelled by the user, the runAsync function is advised to check the future for completion.

asyncRun

public static CompletableFuture<?> asyncRun(Procedures.Procedure1<? super CompletableFuture<?>> runAsync)

Calls asyncRun(Executor,(CompletableFuture<?>)=>void) with the common ForkJoinPool as the executor.

Parameters:

runAsync - the action to execute on the common ForkJoinPool, to which the returned future is passed.

Returns:

a CompletableFuture which will be completed, after successful execution of runAsync, or completed exceptionally if runAsync throws an exception.

See Also:

asyncRun(Executor,org.eclipse.xtext.xbase.lib.Procedures.Procedure1)

asyncRun

public static CompletableFuture<?> asyncRun(Executor executor,
                                            Procedures.Procedure1<? super CompletableFuture<?>> runAsync)

This method will create a CompletableFuture and will run the given runAsync procedure asynchronously, by calling it on the given executor, passing the created future to it. The created future will then be returned from this function.
When the runAsync procedure completes, the future will be completed with a null value. If runAsync throws an exception, the future will be completed exceptionally with the thrown exception. Neither the successful, nor the exceptional execution of runAsync will obtrude the result value into the future. If the future was completed in runAsync this result will stay in the future. However, it is advised to use the future in runAsync only to check for completion from the outside.

Parameters:

executor - will be used to execute runAsync

runAsync - procedure to execute using executor. The future returned from this method will be passed to this procedure to allow checking for completion from the outside.

Returns:

future that will be created in this method and passed to runAsync.

asyncRun

public static CompletableFuture<?> asyncRun(long timeout,
                                            TimeUnit unit,
                                            Procedures.Procedure1<? super CompletableFuture<?>> runAsync)

Calls asyncRun(Executor,long,TimeUnit,(CompletableFuture<?>)=>void) with the common ForkJoinPool as the executor.

Parameters:

timeout - the time in unit after which the returned future will be completed exceptionally.

unit - the time unit for timeout.

runAsync - the action to be called on the common ForkJoinPool. The returned future will be passed to this function on invocation.

Returns:

the future which will be completed with a null value after successful execution of runAsync or exceptionally if runAsync throws an exception.

See Also:

asyncRun(Executor,long,TimeUnit,org.eclipse.xtext.xbase.lib.Procedures.Procedure1)

asyncRun

public static CompletableFuture<?> asyncRun(Executor executor,
                                            long timeout,
                                            TimeUnit unit,
                                            Procedures.Procedure1<? super CompletableFuture<?>> runAsync)

This method will create a CompletableFuture and will run the given runAsync procedure asynchronously, by calling it on the given executor, passing the created future to it. The created future will then be returned from this function.
When the runAsync procedure completes, the future will be completed with a null value. If runAsync throws an exception, the future will be completed exceptionally with the thrown exception. If the runAsync procedure does not finish executing after a timeout defined via timeout and unit, the future will be completed exceptionally with a new TimeoutException.
Neither the successful, nor the exceptional execution of runAsync will obtrude the result value into the future. This includes completion via timeout. If the future was completed in runAsync this result will stay in the future. However, it is advised to use the future in runAsync only to check for completion from the outside.

Parameters:

executor - will be used to execute runAsync

timeout - the time in unit after which the returned future will be completed exceptionally.

unit - the time unit for timeout.

runAsync - procedure to execute using executor. The future returned from this method will be passed to this procedure to allow checking for completion from the outside.

Returns:

future that will be created in this method and passed to runAsync.

asyncRun

public static CompletableFuture<?> asyncRun(Executor executor,
                                            ScheduledExecutorService scheduler,
                                            long timeout,
                                            TimeUnit unit,
                                            Procedures.Procedure1<? super CompletableFuture<?>> runAsync)

This method will create a CompletableFuture and will run the given runAsync procedure asynchronously, by calling it on the given executor, passing the created future to it. The created future will then be returned from this function.
When the runAsync procedure completes, the future will be completed with a null value. If runAsync throws an exception, the future will be completed exceptionally with the thrown exception. If the runAsync procedure does not finish executing after a timeout defined via timeout and unit, the future will be completed exceptionally with a new TimeoutException. The timeout will be scheduled using the given scheduler.
Neither the successful, nor the exceptional execution of runAsync will obtrude the result value into the future. This includes completion via by timeout. If the future was completed in runAsync this result will stay in the future. However, it is advised to use the future in runAsync only to check for completion from the outside.

Parameters:

executor - will be used to execute runAsync.

scheduler - is the executor service used to schedule the exceptional completion after timeout specified via timeout and unit.

timeout - the time in unit after which the returned future will be completed exceptionally.

unit - the time unit for timeout.

runAsync - the action to be called on the common ForkJoinPool. The returned future will be passed to this function on invocation.

runAsync - procedure to execute using executor. The future returned from this method will be passed to this procedure to allow checking for completion from the outside.

Returns:

future that will be created in this method and passed to runAsync.