Spring Framework 6.1.4 · org.springframework.core.task.AsyncTaskExecutor

Modifier and Type	Field and Description
public static final long	TIMEOUT_IMMEDIATE Deprecated as of 5.3.16 along with `execute(Runnable, long)` Constant that indicates immediate execution.
public static final long	TIMEOUT_INDEFINITE Deprecated as of 5.3.16 along with `execute(Runnable, long)` Constant that indicates no time limit.

Method Summary

Modifier and Type	Method and Description
public default void	execute(Runnable the `Runnable` to execute (never `null`) task, long the time duration (milliseconds) within which the task is supposed to start. This is intended as a hint to the executor, allowing for preferred handling of immediate tasks. Typical values are `TIMEOUT_IMMEDIATE` or `TIMEOUT_INDEFINITE` (the default as used by `execute(Runnable)`). startTimeout) Deprecated as of 5.3.16 since the common executors do not support start timeouts Execute the given `task`.
public default Future<?>	Returns: a Future representing pending completion of the task submit(Runnable the `Runnable` to execute (never `null`) task) Submit a Runnable task for execution, receiving a Future representing that task.
public default <T> Future<T>	Returns: a Future representing pending completion of the task submit(Callable<T> the `Callable` to execute (never `null`) task) Submit a Callable task for execution, receiving a Future representing that task.
public default CompletableFuture<Void>	Returns: a `CompletableFuture` representing pending completion of the task submitCompletable(Runnable the `Runnable` to execute (never `null`) task) Submit a `Runnable` task for execution, receiving a `CompletableFuture` representing that task.
public default <T> CompletableFuture<T>	Returns: a `CompletableFuture` representing pending completion of the task submitCompletable(Callable<T> the `Callable` to execute (never `null`) task) Submit a `Callable` task for execution, receiving a `CompletableFuture` representing that task.

Inherited from org.springframework.core.task.TaskExecutor:: execute

TIMEOUT_IMMEDIATE	back to summary
public static final long TIMEOUT_IMMEDIATE Deprecated as of 5.3.16 along with `execute(Runnable, long)` Constant that indicates immediate execution. Annotations @Deprecated

TIMEOUT_INDEFINITE	back to summary
public static final long TIMEOUT_INDEFINITE Deprecated as of 5.3.16 along with `execute(Runnable, long)` Constant that indicates no time limit. Annotations @Deprecated

Method Detail

execute back to summary

execute	back to summary
public default void execute(Runnable task, long startTimeout) Deprecated as of 5.3.16 since the common executors do not support start timeouts Execute the given `task`. As of 6.1, this method comes with a default implementation that simply delegates to `execute(Runnable)`, ignoring the timeout completely. Parameters task:Runnable the `Runnable` to execute (never `null`) startTimeout:long the time duration (milliseconds) within which the task is supposed to start. This is intended as a hint to the executor, allowing for preferred handling of immediate tasks. Typical values are `TIMEOUT_IMMEDIATE` or `TIMEOUT_INDEFINITE` (the default as used by `execute(Runnable)`). Annotations @Deprecated Exceptions TaskTimeoutException: in case of the task being rejected because of the timeout (i.e. it cannot be started in time) TaskRejectedException: if the given task was not accepted See Also `execute(Runnable)`

public default void execute(Runnable task, long startTimeout)

Deprecated

as of 5.3.16 since the common executors do not support start timeouts

Execute the given task.

As of 6.1, this method comes with a default implementation that simply delegates to execute(Runnable), ignoring the timeout completely.

Parameters

task:Runnable: the Runnable to execute (never null)
startTimeout:long: the time duration (milliseconds) within which the task is supposed to start. This is intended as a hint to the executor, allowing for preferred handling of immediate tasks. Typical values are TIMEOUT_IMMEDIATE or TIMEOUT_INDEFINITE (the default as used by execute(Runnable)).

Annotations

@Deprecated

Exceptions

TaskTimeoutException:: in case of the task being rejected because of the timeout (i.e. it cannot be started in time)
TaskRejectedException:: if the given task was not accepted

See Also

execute(Runnable)

submit back to summary

submit	back to summary
public default Future<?> submit(Runnable task) Submit a Runnable task for execution, receiving a Future representing that task. The Future will return a `null` result upon completion. As of 6.1, this method comes with a default implementation that delegates to `execute(Runnable)`. Parameters task:Runnable the `Runnable` to execute (never `null`) Returns:Future<?> a Future representing pending completion of the task Exceptions TaskRejectedException: if the given task was not accepted Since 3.0

public default Future<?> submit(Runnable task)

Submit a Runnable task for execution, receiving a Future representing that task. The Future will return a null result upon completion.

As of 6.1, this method comes with a default implementation that delegates to execute(Runnable).

Parameters

task:Runnable: the Runnable to execute (never null)

Returns:Future<?>

a Future representing pending completion of the task

Exceptions

TaskRejectedException:: if the given task was not accepted

Since

3.0

submit back to summary

submit	back to summary
public default <T> Future<T> submit(Callable<T> task) Submit a Callable task for execution, receiving a Future representing that task. The Future will return the Callable's result upon completion. As of 6.1, this method comes with a default implementation that delegates to `execute(Runnable)`. Parameters task:Callable<T> the `Callable` to execute (never `null`) Returns:Future<T> a Future representing pending completion of the task Exceptions TaskRejectedException: if the given task was not accepted Since 3.0

public default <T> Future<T> submit(Callable<T> task)

Submit a Callable task for execution, receiving a Future representing that task. The Future will return the Callable's result upon completion.

As of 6.1, this method comes with a default implementation that delegates to execute(Runnable).

Parameters

task:Callable<T>: the Callable to execute (never null)

Returns:Future<T>

a Future representing pending completion of the task

Exceptions

TaskRejectedException:: if the given task was not accepted

Since

3.0

submitCompletable back to summary

submitCompletable	back to summary
public default CompletableFuture<Void> submitCompletable(Runnable task) Submit a `Runnable` task for execution, receiving a `CompletableFuture` representing that task. The Future will return a `null` result upon completion. Parameters task:Runnable the `Runnable` to execute (never `null`) Returns:CompletableFuture<Void> a `CompletableFuture` representing pending completion of the task Exceptions TaskRejectedException: if the given task was not accepted Since 6.0

public default CompletableFuture<Void> submitCompletable(Runnable task)

Submit a Runnable task for execution, receiving a CompletableFuture representing that task. The Future will return a null result upon completion.

Parameters

task:Runnable: the Runnable to execute (never null)

Returns:CompletableFuture<Void>

a CompletableFuture representing pending completion of the task

Exceptions

TaskRejectedException:: if the given task was not accepted

Since

6.0

submitCompletable back to summary

submitCompletable	back to summary
public default <T> CompletableFuture<T> submitCompletable(Callable<T> task) Submit a `Callable` task for execution, receiving a `CompletableFuture` representing that task. The Future will return the Callable's result upon completion. Parameters task:Callable<T> the `Callable` to execute (never `null`) Returns:CompletableFuture<T> a `CompletableFuture` representing pending completion of the task Exceptions TaskRejectedException: if the given task was not accepted Since 6.0

public default <T> CompletableFuture<T> submitCompletable(Callable<T> task)

Submit a Callable task for execution, receiving a CompletableFuture representing that task. The Future will return the Callable's result upon completion.

Parameters

task:Callable<T>: the Callable to execute (never null)

Returns:CompletableFuture<T>

a CompletableFuture representing pending completion of the task

Exceptions

TaskRejectedException:: if the given task was not accepted

Since

6.0

public Interface AsyncTaskExecutor

Field Summary

Method Summary

Field Detail

Method Detail