nl.hsac.fitnesse.fixture.util.selenium.by.SingleElementOrNullBy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hsac-fitnesse-fixtures Show documentation

Fixtures to assist in testing via FitNesse

There is a newer version: 5.3.17

Show newest version

package nl.hsac.fitnesse.fixture.util.selenium.by;

import org.openqa.selenium.By;
import org.openqa.selenium.SearchContext;
import org.openqa.selenium.WebElement;

import java.util.Collections;
import java.util.List;
import java.util.function.Function;

/**
 * By which returns either a single element or null.
 * @param  type of element to return.
 */
public abstract class SingleElementOrNullBy extends By {
    /**
     * Converts By to Function returning first result (or null).
     * @param by by to convert.
     * @return function returning first result of by.
     */
    public static  Function byToFunction(By by) {
        Function function;
        if (by instanceof SingleElementOrNullBy) {
            // will not throw exception, but return null when no element is found
            function = sc -> (T) by.findElement(sc);
        } else {
            function = sc -> {
                // single element case will throw exception when no element is found
                List elements = by.findElements(sc);
                return (elements != null && !elements.isEmpty())? (T) elements.get(0) : null;
            };
        }
        return function;
    }

    /**
     * Returns element found in search context.
     * PLEASE NOTE: this implementation will NOT throw an exception when no element is found, but return null.
     * @param context context to find in.
     * @return element found, if any, null otherwise (unlike normal By which throws exception).
     */
    @Override
    public abstract T findElement(SearchContext context);

    @Override
    public List findElements(SearchContext searchContext) {
        T element = findElement(searchContext);
        return element == null? Collections.emptyList(): Collections.singletonList(element);
    }

    @Override
    public String toString() {
        return getByName(getClass());
    }

    public static String getByName(Class c) {
        String name = c.getSimpleName();
        Class enclosingClass = c.getEnclosingClass();
        if (enclosingClass != null) {
            name = enclosingClass.getSimpleName() + "." + name;
        }
        return name;
    }
}