org.catools.common.extensions.wait.interfaces.CBaseWaiter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common Show documentation

The common objects which use in all other CATools projects

There is a newer version: 2.0.0

package org.catools.common.extensions.wait.interfaces;

import org.catools.common.config.CConfigs.TypeExtension;
import org.catools.common.extensions.states.interfaces.CBaseState;

/**
 * CBaseWaiter is an interface to hold shared method between all waiter classes.
 */
public interface CBaseWaiter extends CBaseState {

    /**
     * The default interval in milliseconds during wait for defined state.
     * It is possible to set this value for whole system using {@code WAIT_EXTENSION_DEFAULT_WAIT_INTERVAL_IN_MILLIS}
     * config parameter or just overwrite this method for particular implementation
     *
     * @return the interval time in milliseconds
     */
    default int getDefaultWaitIntervalInMilliSeconds() {
        return TypeExtension.getDefaultWaitIntervalInMilliSeconds();
    }

    /**
     * The default max time to wait for defined state.
     * It is possible to set this value for whole system using {@code WAIT_EXTENSION_DEFAULT_WAIT_IN_SECONDS}
     * config parameter or just overwrite this method for particular implementation.
     *
     * @return max time to wait for defined state.
     */
    default int getDefaultWaitInSeconds() {
        return TypeExtension.getDefaultWaitInSeconds();
    }
}