info.novatec.testit.webtester.waiting.ConfiguredWait Maven / Gradle / Ivy

package info.novatec.testit.webtester.waiting;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NonNull;

import java.util.function.Supplier;


/**
 * This class is used to configure {@link Wait} operations with custom settings like a {@code timeout}.
 *
 * @see Wait
 * @see WaitUntil
 * @see Waiter
 * @see WaitConfig
 * @since 2.0
 */
@Getter(AccessLevel.PACKAGE)
@AllArgsConstructor(access = AccessLevel.PACKAGE)
public class ConfiguredWait {

    /**
     * The {@link Waiter} to use when executing wait operations.
     */
    @NonNull
    private final Waiter waiter;
    /**
     * The {@link WaitConfig} to use when deciding how long to wait.
     */
    @NonNull
    private final WaitConfig config;

    /**
     * Creates a {@link WaitUntil} with this {@link ConfiguredWait}'s {@link ConfiguredWait} for the given object.
     *
     * @param object the object for the wait until operation
     * @param     the type of object
     * @return the fluent wait instance
     * @see Wait
     * @see WaitUntil
     * @see Waiter
     * @see WaitConfig
     * @since 2.0
     */
    public  WaitUntil until(T object) {
        return new WaitUntil<>(waiter, config, object);
    }

    /**
     * Creates a {@link WaitUntil} with this {@link ConfiguredWait}'s {@link ConfiguredWait} for the given object {@link
     * Supplier}.
     *
     * @param objectSupplier the object supplier for the wait until operation
     * @param             the type of the object
     * @return the fluent wait instance
     * @see Wait
     * @see WaitUntil
     * @see Waiter
     * @see WaitConfig
     * @since 2.0
     */
    public  WaitUntil untilSupplied(Supplier objectSupplier) {
        return new WaitUntil<>(waiter, config, objectSupplier);
    }

    /**
     * Executes a wait operation based on this {@link ConfiguredWait}'s {@link ConfiguredWait} and the given boolean
     * supplier. The wait is executed until either the supplier returns true or the timeout is reached.
     *
     * @param condition the supplier for the wait until operation
     * @see Wait
     * @see WaitUntil
     * @see Waiter
     * @see WaitConfig
     * @since 2.0
     */
    public void until(Supplier condition) {
        waiter.waitUntil(config, condition);
    }

    /**
     * Executes a wait operation based on this {@link ConfiguredWait}'s {@link ConfiguredWait} and the given boolean
     * supplier. The wait is executed until either the supplier returns true or the timeout is reached.
     * Additionally executes a {@link WaitAction} configured by the given {@link WaitingAction}.
     *
     * @param condition the supplier for the wait until operation
     * @param waitingAction the configured condition and action to execute during waiting
     * @see Wait
     * @see WaitUntil
     * @see Waiter
     * @see WaitConfig
     * @see WaitingAction
     * @see WaitAction
     * @since 2.8
     */
    public void untilWithAction(Supplier condition, WaitingAction waitingAction) {
        waiter.waitUntilWithAction(config, condition, waitingAction);
    }

}