com.sol.androidphone.AbstractAndroidPageObject.java Source code

Introduction

Here is the source code for com.sol.androidphone.AbstractAndroidPageObject.java

Source

/*******************************************************************************
 * Copyright (c) 2016 Shlomi Reuveni.
 *
 * 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 com.sol.androidphone;

import java.util.Objects;
import java.util.concurrent.TimeUnit;

import org.openqa.selenium.WebElement;

import io.appium.java_client.android.AndroidDriver;

/**
 * An abstract page object for the android phone
 * @author Shlomi Reuveni
 * @version %I%, %G%
 * @since Dec 29 2015
 */
public abstract class AbstractAndroidPageObject {
    /**
     * An android driver instance
     */
    protected final AndroidDriver<WebElement> driver;

    /**
     * A constructor
     * @param driver the driver used to manipulate the page
     */
    public AbstractAndroidPageObject(final AndroidDriver<WebElement> driver) {
        this.driver = Objects.requireNonNull(driver);
    }

    /**
     * Quits this driver, closing every associated window
     */
    public void quit() {
        driver.quit();
    }

    /**
     * Type text into the specified element
     * @param element - element to be typed into
     * @param textToType - text to be typed
     * @param toClearBefore - if true the element will be cleared before typing
     * (as in the method clear()). false indicates that the method will not be
     * cleared
     */
    protected void type(final WebElement element, final String textToType, boolean toClearBefore) {
        assert null != element;
        if (toClearBefore) {
            element.clear();
        }
        element.sendKeys(textToType);
    }

    /**
     * Set an implicit waiting time
     * @param time - time for the implicit wait
     * @param unit - unit for the waiting time (seconds, nanoseconds, minutes,
     * etc.)
     */
    protected void implicitwait(final long time, final TimeUnit unit) {
        assert time >= 0 : "Time is a negetive value!";
        assert null != unit;
        driver.manage().timeouts().implicitlyWait(time, unit);
    }
}