org.abego.guitesting.swing.internal.WaitSupportImpl Maven / Gradle / Ivy

Go to download
/*
 * MIT License
 *
 * Copyright (c) 2019 Udo Borkowski, ([email protected])
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package org.abego.guitesting.swing.internal;

import org.abego.commons.polling.PollingUtil;
import org.abego.commons.timeout.TimeoutSupplier;
import org.abego.guitesting.swing.WaitSupport;
import org.eclipse.jdt.annotation.Nullable;

import java.time.Duration;
import java.util.function.BooleanSupplier;

import static org.abego.commons.lang.ThreadUtil.sleep;
import static org.abego.guitesting.swing.internal.PauseUI.pauseUI;

/**
 * Provide a way to wait (i.e. pause execution of the current Thread),
 * e.g. until a certain condition is matched, some time passed etc.
 *
 * Some methods may throw a {@link org.abego.commons.timeout.TimeoutUncheckedException}
 * when the operation times out. The duration of the timeout is defined by {@link #timeout()}
 */
final class WaitSupportImpl implements WaitSupport {

    private final TimeoutSupplier timeoutProvider;

    private WaitSupportImpl(TimeoutSupplier timeoutProvider) {
        this.timeoutProvider = timeoutProvider;
    }

    /**
     * Return a Pause object with a timeout defined by the given
     * {@code timeoutSupplier}.
     */
    static WaitSupport newWaitSupport(TimeoutSupplier timeoutProvider) {
        return new WaitSupportImpl(timeoutProvider);
    }

    @Override
    public Duration timeout() {
        return timeoutProvider.timeout();
    }

    @Override
    public void waitUntil(BooleanSupplier condition) {
        PollingUtil.poll(condition::getAsBoolean, b -> b, timeout());
    }

    @Override
    public void waitFor(Duration duration) {
        sleep(duration.toMillis());
    }

    @Override
    public void waitForUser(@Nullable String message) {
        pauseUI().showPauseWindowAndWaitForUser(message);
    }

}