de.codecentric.zucchini.web.results.AbstractWebResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zucchini-web Show documentation
Web testing tools.
The newest version!
/*
 * Copyright 2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package de.codecentric.zucchini.web.results;

import de.codecentric.zucchini.bdd.dsl.VariablesAware;
import org.openqa.selenium.By;
import org.openqa.selenium.WebDriver;

import java.util.Map;

/**
 * The abstract web result simplifies the usage implementation of
 * {@link de.codecentric.zucchini.web.results.WebResult web results} by providing common methods.
 */
public abstract class AbstractWebResult implements WebResult, VariablesAware {
	private WebDriver webDriver;

	/**
	 * {@inheritDoc}
	 */
	@Override
	public final void setWebDriver(WebDriver webDriver) {
		this.webDriver = webDriver;
	}

	/**
	 * Returns an instance of the {@link org.openqa.selenium.WebDriver web driver} of the current thread.
	 *
	 * @return An instance of the web driver of the current thread.
	 */
	@SuppressWarnings("WeakerAccess")
    protected final WebDriver getWebDriver() {
		return webDriver;
	}

    /**
     * This method can be used to inject variables into {@link org.openqa.selenium.By} instances that implement
     * {@link de.codecentric.zucchini.bdd.dsl.VariablesAware}.
     *
     * If the element does not implement {@link de.codecentric.zucchini.bdd.dsl.VariablesAware}, then no injection will
     * occur.
     *
     * @param variables The variables that will be injected.
     * @param element The element.
     */
    @SuppressWarnings("WeakerAccess")
    protected final void injectVariables(Map variables, By element) {
        if (element instanceof VariablesAware) {
            ((VariablesAware) element).setVariables(variables);
        }
    }
}