org.jboss.elemento.flow.Flow Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elemento-flow Show documentation
Parallel, sequential, repeated and nested execution of asynchronous tasks using promises.
There is a newer version: 1.6.10
/*
 *  Copyright 2023 Red Hat
 *
 *  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.jboss.elemento.flow;

import java.util.List;

import static org.jboss.elemento.flow.SequenceImpl.Mode.PARALLEL;
import static org.jboss.elemento.flow.SequenceImpl.Mode.SEQUENTIAL;

/**
 * An interface to execute a list of {@linkplain Task asynchronous tasks} in parallel or sequentially, or to execute a single
 * {@linkplain Task task} {@linkplain #repeat(FlowContext, Task) repeatedly} as long as certain conditions are met.
 * 
 * The {@linkplain Task tasks} share a {@linkplain FlowContext context} that can be used to store data in a map or on a stack.
 * {@snippet class = FlowDemo region = sequential}
 */
public interface Flow {

    /**
     * Executes a list of {@linkplain Task asynchronous tasks} in parallel (all at once).
     * {@snippet class = FlowDemo region = parallel}
     *
     * @param context the context shared between tasks
     * @param tasks the list of tasks to execute in parallel
     * @param  the type of the shared context
     * @return an interface to control whether the execution of the tasks should fail fast or fail last
     */
    static  Sequence parallel(C context, List> tasks) {
        return new SequenceImpl<>(PARALLEL, context, tasks);
    }

    /**
     * Executes a list of {@linkplain Task asynchronous tasks} in sequence (one after the other).
     * {@snippet class = FlowDemo region = sequential}
     *
     * @param context the context shared between tasks
     * @param tasks the list of tasks to execute in order
     * @param  the type of the shared context
     * @return an interface to control whether the execution of the tasks should fail fast or fail last
     */
    static  Sequence sequential(C context, List> tasks) {
        return new SequenceImpl<>(SEQUENTIAL, context, tasks);
    }

    /**
     * Executes the given {@linkplain Task task} repeatedly as long as the conditions defined by {@link Repeat} are met.
     * {@snippet class = FlowDemo region = repeat}
     *
     * @param context the context shared between the iterations
     * @param task the task to execute while the predicate evaluates to {@code true}
     * @param  the type of the shared context
     * @return an interface to control the interval, timeout and fail fast behaviour
     */
    static  Repeat repeat(C context, Task task) {
        return new RepeatImpl<>(context, task);
    }
}