org.fluentlenium.configuration.ConfigurationMutator Maven / Gradle / Ivy

package org.fluentlenium.configuration;

import org.openqa.selenium.Capabilities;

/**
 * Mutation interface of Configuration Properties.
 *
 * @see ConfigurationProperties
 */
public interface ConfigurationMutator {
    /**
     * Sets the value of webDriver property.
     *
     * @param webDriver property value
     * @see ConfigurationProperties#getWebDriver()
     */
    void setWebDriver(String webDriver);

    /**
     * Sets the value of browserTimeout property.
     *
     * @param timeout property value
     * @see ConfigurationProperties#getBrowserTimeout()
     */
    void setBrowserTimeout(Long timeout);

    /**
     * Sets the value of browserTimeoutRetries property.
     *
     * @param retriesNumber property value
     * @see ConfigurationProperties#getBrowserTimeoutRetries()
     */
    void setBrowserTimeoutRetries(Integer retriesNumber);

    /**
     * Sets the value of remoteUrl property.
     *
     * @param remoteUrl property value
     * @see ConfigurationProperties#getRemoteUrl()
     */
    void setRemoteUrl(String remoteUrl);

    /**
     * Sets the value of capabilities property.
     *
     * @param capabilities property value
     * @see ConfigurationProperties#getCapabilities()
     */
    void setCapabilities(Capabilities capabilities);

    /**
     * Sets the value of configurationFactory property.
     *
     * @param configurationFactory property value
     * @see ConfigurationProperties#getConfigurationFactory()
     */
    void setConfigurationFactory(Class configurationFactory);

    /**
     * Sets the value of driverLifecycle property.
     *
     * @param driverLifecycle property value
     * @see ConfigurationProperties#getDriverLifecycle()
     */
    void setDriverLifecycle(ConfigurationProperties.DriverLifecycle driverLifecycle);

    /**
     * Sets the value of deleteCookies property.
     *
     * @param deleteCookies property value
     * @see ConfigurationProperties#getDeleteCookies()
     */
    void setDeleteCookies(Boolean deleteCookies);

    /**
     * Sets the value of baseUrl property.
     *
     * @param baseUrl property value
     * @see ConfigurationProperties#getBaseUrl() ()
     */
    void setBaseUrl(String baseUrl);

    /**
     * Sets the value of pageLoadTimeout property.
     *
     * @param pageLoadTimeout property value
     * @see ConfigurationProperties#getPageLoadTimeout()
     */
    void setPageLoadTimeout(Long pageLoadTimeout);

    /**
     * Sets the value of implicitlyWait property.
     *
     * @param implicitlyWait property value
     * @see ConfigurationProperties#getImplicitlyWait()
     */
    void setImplicitlyWait(Long implicitlyWait);

    /**
     * Sets the value of awaitAtMost property
     *
     * @param awaitAtMost property value
     * @see ConfigurationProperties#getAwaitAtMost()
     */
    void setAwaitAtMost(Long awaitAtMost);

    /**
     * Sets the value of awaitPollingEvery property
     *
     * @param awaitPollingEvery property value
     * @see ConfigurationProperties#getAwaitPollingEvery()
     */
    void setAwaitPollingEvery(Long awaitPollingEvery);

    /**
     * Sets the value of scriptTimeout property.
     *
     * @param scriptTimeout property value
     * @see ConfigurationProperties#getScriptTimeout()
     */
    void setScriptTimeout(Long scriptTimeout);

    /**
     * Sets the value of eventsEnabled property.
     *
     * @param eventsEnabled property value
     */
    void setEventsEnabled(Boolean eventsEnabled);

    /**
     * Sets the value of screenshotPath property.
     *
     * @param screenshotPath property value
     * @see ConfigurationProperties#getScreenshotPath()
     */
    void setScreenshotPath(String screenshotPath);

    /**
     * Sets the value of screenshotMode property.
     *
     * @param screenshotMode property value
     * @see ConfigurationProperties#getScreenshotMode()
     */
    void setScreenshotMode(ConfigurationProperties.TriggerMode screenshotMode);

    /**
     * Sets the value of htmlDumpPath property.
     *
     * @param htmlDumpPath property value
     * @see ConfigurationProperties#getHtmlDumpPath()
     */
    void setHtmlDumpPath(String htmlDumpPath);

    /**
     * Sets the value of htmlDumpMode property.
     *
     * @param htmlDumpMode property value
     * @see ConfigurationProperties#getHtmlDumpMode()
     */
    void setHtmlDumpMode(ConfigurationProperties.TriggerMode htmlDumpMode);

    /**
     * Sets custom value for a custom property key
     *
     * @param key   custom property key
     * @param value custom property value
     */
    void setCustomProperty(String key, String value);
}