de.codecentric.zucchini.web.pageobjects.AbstractPageObject 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.pageobjects;

import org.openqa.selenium.WebDriver;

/**
 * The abstract page object simplifies the implementation of custom page objects by providing implementations of methods
 * that are common for all page objects.
 */
public abstract class AbstractPageObject implements PageObject {
	private WebDriver webDriver;

	/**
	 * Opens the page whose URL has been returned by {@code getUrl()}.
	 *
	 * @throws IllegalPageObjectConfigurationException Thrown if {@code getUrl()} returns {@literal null}.
	 */
	@Override
	public void open() {
		String url = getUrl();
		if (url == null) {
			throw new IllegalPageObjectConfigurationException(String.format("%s.getUrl() must not return null.", this.getClass().getName()));
		}
		webDriver.get(url);
	}

	/**
	 * This method must be implemented by subclasses.
	 *
	 * @return The URL of the page described by the page object.
	 */
	protected abstract String getUrl();

	/**
	 * Sets the web driver.
	 *
	 * This method is called by the {@link de.codecentric.zucchini.web.facts.OnPageFact} before {@code open()} is
	 * called.
	 *
	 * @param webDriver The web driver.
	 */
	public void setWebDriver(WebDriver webDriver) {
		this.webDriver = webDriver;
	}

	/**
	 * Returns a human-readable description of this page object.
	 *
	 * @return A human-readable description of this page object.
	 */
	@Override
	public String toString() {
		return getClass().getSimpleName() + "{url=" + getUrl() + '}';
	}
}