io.appium.java_client.pagefactory.WidgetByBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation
Java client for Appium Mobile Webdriver
There is a newer version: 9.3.0
/*
 * 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 io.appium.java_client.pagefactory;

import static io.appium.java_client.pagefactory.OverrideWidgetReader.getDefaultOrHTMLWidgetClass;
import static io.appium.java_client.pagefactory.OverrideWidgetReader.getMobileNativeWidgetClass;
import static java.util.Optional.ofNullable;

import org.openqa.selenium.By;

import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.List;

public class WidgetByBuilder extends DefaultElementByBuilder {

    public WidgetByBuilder(String platform, String automation) {
        super(platform, automation);
    }

    private static Class getClassFromAListField(Field field) {
        Type genericType = field.getGenericType();
        if (!(genericType instanceof ParameterizedType)) {
            return null;
        }

        Type listType = ((ParameterizedType) genericType).getActualTypeArguments()[0];
        if (ParameterizedType.class.isAssignableFrom(listType.getClass())) {
            listType = ((ParameterizedType) listType).getRawType();
        }

        return (Class) listType;
    }

    @SuppressWarnings("unchecked")
    private By getByFromDeclaredClass(WhatIsNeeded whatIsNeeded) {
        AnnotatedElement annotatedElement = annotatedElementContainer.getAnnotated();
        Field field = Field.class.cast(annotatedElement);
        Class declaredClass;

        By result = null;
        try {
            if (List.class.isAssignableFrom(field.getType())) {
                declaredClass = getClassFromAListField(field);
            } else {
                declaredClass = field.getType();
            }

            Class convenientClass;

            if (whatIsNeeded.equals(WhatIsNeeded.DEFAULT_OR_HTML)) {
                convenientClass =
                    getDefaultOrHTMLWidgetClass((Class) declaredClass, field);
            } else {
                convenientClass =
                    getMobileNativeWidgetClass((Class) declaredClass, field,
                        platform);
            }

            while (result == null && !convenientClass.equals(Object.class)) {
                setAnnotated(convenientClass);
                if (whatIsNeeded.equals(WhatIsNeeded.DEFAULT_OR_HTML)) {
                    result = super.buildDefaultBy();
                } else {
                    result = super.buildMobileNativeBy();
                }

                convenientClass = convenientClass.getSuperclass();
            }
            return result;
        } finally {
            if (field != null) {
                setAnnotated(field);
            }
        }
    }

    @Override protected By buildDefaultBy() {
        return ofNullable(super.buildDefaultBy())
                .orElseGet(() -> getByFromDeclaredClass(WhatIsNeeded.DEFAULT_OR_HTML));
    }

    @Override protected By buildMobileNativeBy() {
        return ofNullable(super.buildMobileNativeBy())
                .orElseGet(() -> getByFromDeclaredClass(WhatIsNeeded.MOBILE_NATIVE));
    }

    private enum WhatIsNeeded {
        DEFAULT_OR_HTML,
        MOBILE_NATIVE
    }
}