info.novatec.testit.webtester.browser.operations.JavaScriptExecutor Maven / Gradle / Ivy

package info.novatec.testit.webtester.browser.operations;

import org.openqa.selenium.JavascriptExecutor;

import info.novatec.testit.webtester.browser.Browser;
import info.novatec.testit.webtester.pagefragments.PageFragment;


/**
 * This browser operation offers methods related to the execution of JavaScript code.
 *
 * @see #execute(String, Object...)
 * @see #execute(String, PageFragment, Object...)
 * @since 2.0
 */
public class JavaScriptExecutor extends BaseBrowserOperation {

    /**
     * Creates a new {@link JavaScriptExecutor} for the given {@link Browser}.
     *
     * @param browser the browser to use
     * @since 2.0
     */
    public JavaScriptExecutor(Browser browser) {
        super(browser);
    }

    /**
     * Executes the given JavaScript code for the given {@link PageFragment}
     * (available in script as arguments[0]) with the given parameters
     * (accessible as arguments[1] - arguments[n]).
     *
     * @param script the JavaScript code to be executed on the current page
     * @param fragment the target {@link PageFragment}
     * @param parameters any of Boolean, Long, String, List, WebElement or null.
     * @see JavascriptExecutor#executeScript(String, Object...)
     * @since 2.0
     */
    public void execute(String script, PageFragment fragment, Object... parameters) {
        executeWithReturn(script, fragment, parameters);
    }

    /**
     * Executes the given JavaScript code for the given {@link PageFragment} (available in script as arguments[0])
     * with the given parameters (accessible as arguments[1] - arguments[n]).
     * 
     * The JavaScripts return value is returned as described in {@link JavascriptExecutor#executeScript(String, Object...)}.
     *
     * @param script the JavaScript code to be executed on the current page
     * @param fragment the target {@link PageFragment}
     * @param parameters any of Boolean, Long, String, List, WebElement or null.
     * @param  the expected type of the return value
     * @return the return value of the JavaScript
     * @see JavascriptExecutor#executeScript(String, Object...)
     * @since 2.0
     */
    public  T executeWithReturn(String script, PageFragment fragment, Object... parameters) {
        Object[] parameterArray = new Object[parameters.length + 1];
        parameterArray[0] = fragment.webElement();
        System.arraycopy(parameters, 0, parameterArray, 1, parameters.length);
        return executeWithReturn(script, parameterArray);
    }

    /**
     * Executes the given JavaScript code with the given parameters (accessible as arguments[0] - arguments[n]).
     *
     * @param script the JavaScript code to be executed on the current page
     * @param parameters any of Boolean, Long, String, List, WebElement or null.
     * @see JavascriptExecutor#executeScript(String, Object...)
     * @since 2.0
     */
    public void execute(String script, Object... parameters) {
        executeWithReturn(script, parameters);
    }

    /**
     * Executes the given JavaScript code with the given parameters (accessible as arguments[0] - arguments[n]).
     * 
     * The JavaScripts return value is returned as described in {@link JavascriptExecutor#executeScript(String, Object...)}.
     *
     * @param script the JavaScript code to be executed on the current page
     * @param parameters any of Boolean, Long, String, List, WebElement or null.
     * @param  the type of the return value is cast to before returning
     * @return the return value of the JavaScript
     * @see JavascriptExecutor#executeScript(String, Object...)
     * @since 2.0
     */
    @SuppressWarnings("unchecked")
    public  T executeWithReturn(String script, Object... parameters) {
        if (!(webDriver() instanceof JavascriptExecutor)) {
            throw new UnsupportedOperationException("WebDriver does not support JavaScript execution!");
        }
        JavascriptExecutor javascriptExecutor = ( JavascriptExecutor ) webDriver();
        return (T) javascriptExecutor.executeScript(script, parameters);
    }

}