/*
 * Copyright 2002-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.core.task;

A callback interface for a decorator to be applied to any Runnable about to be executed.

Note that such a decorator is not necessarily being applied to the user-supplied Runnable/Callable but rather to the actual execution callback (which may be a wrapper around the user-supplied task).

The primary use case is to set some execution context around the task's invocation, or to provide some monitoring/statistics for task execution.

NOTE: Exception handling in TaskDecorator implementations may be limited. Specifically in case of a Future-based operation, the exposed Runnable will be a wrapper which does not propagate any exceptions from its run method.

Author:Juergen Hoeller
See Also:
Since:4.3
/** * A callback interface for a decorator to be applied to any {@link Runnable} * about to be executed. * * <p>Note that such a decorator is not necessarily being applied to the * user-supplied {@code Runnable}/{@code Callable} but rather to the actual * execution callback (which may be a wrapper around the user-supplied task). * * <p>The primary use case is to set some execution context around the task's * invocation, or to provide some monitoring/statistics for task execution. * * <p><b>NOTE:</b> Exception handling in {@code TaskDecorator} implementations * may be limited. Specifically in case of a {@code Future}-based operation, * the exposed {@code Runnable} will be a wrapper which does not propagate * any exceptions from its {@code run} method. * * @author Juergen Hoeller * @since 4.3 * @see TaskExecutor#execute(Runnable) * @see SimpleAsyncTaskExecutor#setTaskDecorator * @see org.springframework.core.task.support.TaskExecutorAdapter#setTaskDecorator */
@FunctionalInterface public interface TaskDecorator {
Decorate the given Runnable, returning a potentially wrapped Runnable for actual execution, internally delegating to the original Runnable.run() implementation.
Params:
  • runnable – the original Runnable
Returns:the decorated Runnable
/** * Decorate the given {@code Runnable}, returning a potentially wrapped * {@code Runnable} for actual execution, internally delegating to the * original {@link Runnable#run()} implementation. * @param runnable the original {@code Runnable} * @return the decorated {@code Runnable} */
Runnable decorate(Runnable runnable); }