How to use unpackWebDriverFromSearchContext method of io.appium.java_client.pagefactory.utils.WebDriverUnpackUtility class

Best io.appium code snippet using io.appium.java_client.pagefactory.utils.WebDriverUnpackUtility.unpackWebDriverFromSearchContext

AppiumFieldDecorator.java

Source:AppiumFieldDecorator.java

...17import static io.appium.java_client.pagefactory.utils.ProxyFactory.getEnhancedProxy;18import static io.appium.java_client.pagefactory.utils.WebDriverUnpackUtility.getAutomation;19import static io.appium.java_client.pagefactory.utils.WebDriverUnpackUtility.getPlatform;20import static io.appium.java_client.pagefactory.utils.WebDriverUnpackUtility21    .unpackWebDriverFromSearchContext;22import io.appium.java_client.MobileElement;23import io.appium.java_client.TouchableElement;24import io.appium.java_client.android.AndroidDriver;25import io.appium.java_client.android.AndroidElement;26import io.appium.java_client.ios.IOSDriver;27import io.appium.java_client.ios.IOSElement;28import io.appium.java_client.pagefactory.bys.ContentType;29import io.appium.java_client.pagefactory.locator.CacheableLocator;30import org.openqa.selenium.SearchContext;31import org.openqa.selenium.WebDriver;32import org.openqa.selenium.WebElement;33import org.openqa.selenium.remote.RemoteWebElement;34import org.openqa.selenium.support.pagefactory.DefaultFieldDecorator;35import org.openqa.selenium.support.pagefactory.ElementLocator;36import org.openqa.selenium.support.pagefactory.FieldDecorator;37import java.lang.reflect.Constructor;38import java.lang.reflect.Field;39import java.lang.reflect.ParameterizedType;40import java.lang.reflect.Type;41import java.util.ArrayList;42import java.util.HashMap;43import java.util.List;44import java.util.Map;45import java.util.concurrent.TimeUnit;46/**47 * Default decorator for use with PageFactory. Will decorate 1) all of the48 * WebElement fields and 2) List of WebElement that have49 * {@literal @AndroidFindBy}, {@literal @AndroidFindBys}, or50 * {@literal @iOSFindBy/@iOSFindBys} annotation with a proxy that locates the51 * elements using the passed in ElementLocatorFactory.52 * Please pay attention: fields of {@link WebElement}, {@link RemoteWebElement},53 * {@link MobileElement}, {@link AndroidElement} and {@link IOSElement} are allowed54 * to use with this decorator55 */56public class AppiumFieldDecorator implements FieldDecorator {57    private static final List<Class<? extends WebElement>> availableElementClasses =58        new ArrayList<Class<? extends WebElement>>() {59            private static final long serialVersionUID = 1L;60            {61                add(WebElement.class);62                add(RemoteWebElement.class);63                add(MobileElement.class);64                add(TouchableElement.class);65                add(AndroidElement.class);66                add(IOSElement.class);67            }68        };69    private static final Map<Class<? extends SearchContext>, Class<? extends WebElement>>70        elementRuleMap =71        new HashMap<Class<? extends SearchContext>, Class<? extends WebElement>>() {72            private static final long serialVersionUID = 1L;73            {74                put(AndroidDriver.class, AndroidElement.class);75                put(IOSDriver.class, IOSElement.class);76            }77        };78    public static long DEFAULT_IMPLICITLY_WAIT_TIMEOUT = 1;79    public static TimeUnit DEFAULT_TIMEUNIT = TimeUnit.SECONDS;80    private final WebDriver originalDriver;81    private final DefaultFieldDecorator defaultElementFieldDecoracor;82    private final AppiumElementLocatorFactory widgetLocatorFactory;83    private final String platform;84    private final String automation;85    private final TimeOutDuration timeOutDuration;86    public AppiumFieldDecorator(SearchContext context, long implicitlyWaitTimeOut,87        TimeUnit timeUnit) {88        this(context, new TimeOutDuration(implicitlyWaitTimeOut, timeUnit));89    }90    /**91     * @param context is an instance of {@link org.openqa.selenium.SearchContext}92     *                It may be the instance of {@link org.openqa.selenium.WebDriver}93     *                or {@link org.openqa.selenium.WebElement} or94     *                {@link io.appium.java_client.pagefactory.Widget} or some other user's95     *                extension/implementation.96     * @param timeOutDuration is a desired duration of the waiting for an element presence.97     */98    public AppiumFieldDecorator(SearchContext context, TimeOutDuration timeOutDuration) {99        this.originalDriver = unpackWebDriverFromSearchContext(context);100        platform = getPlatform(originalDriver);101        automation = getAutomation(originalDriver);102        this.timeOutDuration = timeOutDuration;103        defaultElementFieldDecoracor = new DefaultFieldDecorator(104            new AppiumElementLocatorFactory(context, timeOutDuration, originalDriver,105                new DefaultElementByBuilder(platform, automation))) {106            @Override107            protected WebElement proxyForLocator(ClassLoader ignored, ElementLocator locator) {108                return proxyForAnElement(locator);109            }110            @Override111            @SuppressWarnings("unchecked")112            protected List<WebElement> proxyForListLocator(ClassLoader ignored,113                ElementLocator locator) {...

WebDriverUnpackUtility.java

Source:WebDriverUnpackUtility.java

...39     *         {@link org.openqa.selenium.internal.WrapsElement} then this method returns40     *         null.41     *42     */43    public static WebDriver unpackWebDriverFromSearchContext(SearchContext searchContext) {44        if (searchContext instanceof WebDriver) {45            return (WebDriver) searchContext;46        }47        if (searchContext instanceof WrapsDriver) {48            return unpackWebDriverFromSearchContext(49                    ((WrapsDriver) searchContext).getWrappedDriver());50        }51        // Search context it is not only Webdriver. Webelement is search context52        // too.53        // RemoteWebElement and MobileElement implement WrapsDriver54        if (searchContext instanceof WrapsElement) {55            return unpackWebDriverFromSearchContext(56                    ((WrapsElement) searchContext).getWrappedElement());57        }58        return null;59    }60    /**61     * @param context is an instance of {@link org.openqa.selenium.SearchContext}62     *                It may be the instance of {@link org.openqa.selenium.WebDriver}63     *                or {@link org.openqa.selenium.WebElement} or some other user's64     *                extension/implementation.65     *                Note: if you want to use your own implementation then it should66     *                implement {@link org.openqa.selenium.ContextAware} or67     *                {@link org.openqa.selenium.internal.WrapsDriver}68     * @return current content type. It depends on current context. If current context is69     *     NATIVE_APP it will return70     * {@link io.appium.java_client.pagefactory.bys.ContentType#NATIVE_MOBILE_SPECIFIC}.71     * {@link io.appium.java_client.pagefactory.bys.ContentType#HTML_OR_DEFAULT} will be returned72     *     if the current context is WEB_VIEW.73     * {@link io.appium.java_client.pagefactory.bys.ContentType#HTML_OR_DEFAULT} also will be74     *     returned if the given {@link org.openqa.selenium.SearchContext}75     *     instance doesn't implement76     * {@link org.openqa.selenium.ContextAware} and {@link org.openqa.selenium.internal.WrapsDriver}77     */78    public static ContentType getCurrentContentType(SearchContext context) {79        WebDriver driver = WebDriverUnpackUtility.unpackWebDriverFromSearchContext(context);80        if (!ContextAware.class.isAssignableFrom(driver.getClass())) { //it is desktop browser81            return ContentType.HTML_OR_DEFAULT;82        }83        ContextAware contextAware = ContextAware.class.cast(driver);84        String currentContext = contextAware.getContext();85        if (currentContext.contains(NATIVE_APP_PATTERN)) {86            return ContentType.NATIVE_MOBILE_SPECIFIC;87        }88        return ContentType.HTML_OR_DEFAULT;89    }90}...

SapiumFieldDecorator.java

Source:SapiumFieldDecorator.java

...52	private final WebDriver originalDriver;5354	public SapiumFieldDecorator(SearchContext context, ElementLocatorFactory factory) {55		this.factory = factory;56		this.originalDriver = WebDriverUnpackUtility.unpackWebDriverFromSearchContext(context);57	}58	59	@Override60	public Object decorate(ClassLoader loader, Field field) {61		if (!(WebElement.class.isAssignableFrom(field.getType())62				|| isDecoratableList(field))) {63			return null;64		}65			66		ElementLocator locator = factory.createLocator(field);67		68		if (locator == null) {69			return null;70		}
...

Widget.java

Source:Widget.java

...14 * limitations under the License.15 */16package io.appium.java_client.pagefactory;17import static io.appium.java_client.pagefactory.utils.WebDriverUnpackUtility18    .unpackWebDriverFromSearchContext;19import org.openqa.selenium.By;20import org.openqa.selenium.SearchContext;21import org.openqa.selenium.WebDriver;22import org.openqa.selenium.WebElement;23import org.openqa.selenium.internal.WrapsDriver;24import org.openqa.selenium.internal.WrapsElement;25import java.util.List;26/**27 * It is the Appium-specific extension of the Page Object design pattern. It allows user28 * to create objects which typify some element with nested sub-elements. Also it allows to29 * describe and encapsulate logic of interaction/behavior within.30 * About the Page Object design pattern please read these documents:31 * - https://code.google.com/p/selenium/wiki/PageObjects32 * - https://code.google.com/p/selenium/wiki/PageFactory33 */34public abstract class Widget implements SearchContext, WrapsDriver, WrapsElement {35    private final SearchContext element;36    protected Widget(WebElement element) {37        this.element = element;38    }39    @Override public List<WebElement> findElements(By by) {40        return element.findElements(by);41    }42    @Override public WebElement findElement(By by) {43        return element.findElement(by);44    }45    @Override public WebDriver getWrappedDriver() {46        return unpackWebDriverFromSearchContext(element);47    }48    @Override public WebElement getWrappedElement() {49        return (WebElement) element;50    }51    public Widget getSelfReference() {52        return this;53    }54}...