org.fluentlenium.core.page.ClassAnnotations Maven / Gradle / Ivy

package org.fluentlenium.core.page;

import org.openqa.selenium.By;
import org.openqa.selenium.support.CacheLookup;
import org.openqa.selenium.support.FindAll;
import org.openqa.selenium.support.FindBy;
import org.openqa.selenium.support.FindBys;
import org.openqa.selenium.support.pagefactory.AbstractAnnotations;

/**
 * Inspired by {@link org.openqa.selenium.support.pagefactory.Annotations}, but use a Class instead of a Field
 * to retrieve the annotations.
 */
public class ClassAnnotations extends AbstractAnnotations {
    private final Class containerClass;

    /**
     * Creates a new class annotations.
     *
     * @param containerClass container class on witch to read annotations
     */
    public ClassAnnotations(Class containerClass) {
        this.containerClass = containerClass;
    }

    @Override
    public boolean isLookupCached() {
        return containerClass.getAnnotation(CacheLookup.class) != null;
    }

    /**
     * {@inheritDoc}
     * 
     * Looks for one of {@link org.openqa.selenium.support.FindBy},
     * {@link org.openqa.selenium.support.FindBys} or
     * {@link org.openqa.selenium.support.FindAll} class annotations. In case
     * no annotation is provided for the field, returns null.
     *
     * @throws IllegalArgumentException when more than one annotation on a class provided
     */
    public By buildBy() {
        assertValidAnnotations();

        By ans = null;

        FindBys findBys = containerClass.getAnnotation(FindBys.class);
        if (findBys != null) {
            ans = new FindBys.FindByBuilder().buildIt(findBys, null);
        }

        FindAll findAll = containerClass.getAnnotation(FindAll.class);
        if (ans == null && findAll != null) {
            ans = new FindAll.FindByBuilder().buildIt(findAll, null);
        }

        FindBy findBy = containerClass.getAnnotation(FindBy.class);
        if (ans == null && findBy != null) {
            ans = new FindBy.FindByBuilder().buildIt(findBy, null);
        }

        return ans;
    }

    /**
     * Assert that defined annotations are valid.
     */
    private void assertValidAnnotations() {
        FindBys findBys = containerClass.getAnnotation(FindBys.class);
        FindAll findAll = containerClass.getAnnotation(FindAll.class); // NOPMD PrematureDeclaration
        FindBy findBy = containerClass.getAnnotation(FindBy.class);
        if (findBys != null && findBy != null) {
            throw new IllegalArgumentException(
                    "If you use a '@FindBys' annotation, you must not also use a '@FindBy' annotation");
        }
        if (findAll != null && findBy != null) {
            throw new IllegalArgumentException(
                    "If you use a '@FindAll' annotation, you must not also use a '@FindBy' annotation");
        }
        if (findAll != null && findBys != null) {
            throw new IllegalArgumentException(
                    "If you use a '@FindAll' annotation, you must not also use a '@FindBys' annotation");
        }
    }
}