java-design-patterns/page-object/src/test/java/com/iluwatar/pageobject/pages/Page.java

/**
 * The MIT License
 * Copyright (c) 2014-2016 Ilkka Seppälä
 * <p>
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * <p>
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * <p>
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.iluwatar.pageobject.pages;

import com.gargoylesoftware.htmlunit.WebClient;

/**
 * Encapsulation for a generic 'Page'
 */
public abstract class Page {

  /**
   * Application Under Test path
   * This directory location is where html web pages are located
   */
  public static final String AUT_PATH = "src/main/resources/sample-ui/";

  protected final WebClient webClient;

  /**
   * Constructor
   *
   * @param webClient {@link WebClient}
   */
  public Page(WebClient webClient) {
    this.webClient = webClient;
  }

  /**
   * Checks that the current page is actually the page this page object represents
   *
   * @return true if so, otherwise false
   */
  public abstract boolean isAt();


}