org.jboss.hal.flow.Repeat Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hal-flow Show documentation
Async Flow based on Promise API
The newest version!
/*
 *  Copyright 2022 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.hal.flow;

import java.util.function.Predicate;

/**
 * An interface to control the {@linkplain Flow#repeat(FlowContext, Task) repeated} execution of an {@linkplain Task
 * asynchronous task}.
 *
 * @param  the type of the {@linkplain FlowContext context} shared between tasks
 */
public interface Repeat extends Promisable, Subscription {

    /**
     * By default, the execution of {@linkplain Task task} fails fast.
     */
    boolean DEFAULT_FAIL_FAST = true;

    /**
     * By default, the interval between the iterations is 1 second.
     */
    long DEFAULT_INTERVAL = 1_000;

    /**
     * By default, the timeout for the loop is 10 seconds.
     */
    long DEFAULT_TIMEOUT = 10_000;

    /**
     * By default, the number of iterations are infinite.
     */
    int DEFAULT_ITERATIONS = -1;

    /**
     * The task is executed as long as the given predicate evaluates to {@code true}. Defaults to a precondition which always
     * returns {@code true}.
     */
    Repeat while_(Predicate predicate);

    /**
     * Whether the execution of the {@linkplain Task task} should fail fast or fail last. Defaults to
     * {@value Repeat#DEFAULT_FAIL_FAST}.
     */
    Repeat failFast(boolean failFast);

    /**
     * The interval in milliseconds between the iterations. Defaults to {@value Repeat#DEFAULT_INTERVAL} milliseconds.
     */
    Repeat interval(long interval);

    /**
     * The timeout in milliseconds for the while loop. Defaults to {@value Repeat#DEFAULT_TIMEOUT} milliseconds.
     */
    Repeat timeout(long timeout);

    /**
     * The maximal number of iterations of the loop. Defaults to an infinite loop ({@value Repeat#DEFAULT_ITERATIONS}).
     */
    Repeat iterations(int iterations);
}