co.verisoft.fw.async.SeleniumTask Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Selenium4-Junit5 Show documentation
VeriSoft framework for testing web and mobile applications. Selenium Module
There is a newer version: 2.3.9
/*
 * (C) Copyright 2022 VeriSoft (http://www.verisoft.co)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * 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 co.verisoft.fw.async;


/**
 * This is a simple interface for an async selenium task.
 * This interface is used to describe a set of actions to be performed asynchronously.


 * Example #1

 * The following code example creates an async script to get and print the page title to the
 * STDIO, and then asks to be unregistered from further executions.


 * {@code
 * Observer o = new AsyncTask(driver, new SeleniumTask() {
 *             @Override
 *             public boolean doTask() {
 *                 String pageTitle = driver.getCurrentUrl();
 *                 System.out.println("Time is " + LocalTime.now() + ", page url is " + pageTitle);
 *                 return false;
 *             }
 *         });
 *         driver.async().setDispatchInterval(2, ChronoUnit.SECONDS);
 *         driver.async().register(o);
 *         }



 *
 * Example #2

 * The following code waits for a popup to appear on the screen, and after it appears, click on dismiss
 * and then asks to be unregistered from further executions. It uses the default dispatch interval,
 * which is 1 second:


 *
 * {@code
 * Observer o = new AsyncTask(driver, new SeleniumTask() {
 *             @Override
 *             public boolean doTask() {
 *                 boolean result = false;
 *
 *                 List elements = driver.findElements(By.id("popup-button-dismiss-locator"));
 *                 if (elements.isEmpty())
 *                     return false;
 *
 *                 try{
 *                     elements.get(0).click();
 *                     result = true;
 *                 }
 *                 catch(Throwable t)
 *                     result = false;
 *
 *                 return result;
 *             }
 *         });
 *         driver.async().register(o);
 *         }



 *
 * @author Nir Gallner @ www.VeriSoft.co
 * @since 2.0.3
 */
public interface SeleniumTask {

    /**
     * Asynchronous task to be performed, repeatedly until the tasks asks to be unregistered
     *
     * @return 
true, meaning the task is completed and wishes to be unregistered and not to be invoked again

     * false, meaning the task needs to run again, and should be invoked next time as well
     */
    boolean doTask();
}