How to use CacheableLocator class of io.appium.java_client.pagefactory.locator package

Best io.appium code snippet using io.appium.java_client.pagefactory.locator.CacheableLocator

WidgetInterceptor.java

Source:WidgetInterceptor.java

...32import io.appium.java_client.pagefactory.TimeOutDuration;33import io.appium.java_client.pagefactory.Widget;34import io.appium.java_client.pagefactory.bys.ContentType;35import io.appium.java_client.pagefactory.interceptors.InterceptorOfASingleElement;36import io.appium.java_client.pagefactory.locator.CacheableLocator;37import net.sf.cglib.proxy.MethodProxy;3839class WidgetInterceptor extends InterceptorOfASingleElement {4041	private WebElement cachedElement;42	private final Map<ContentType, Widget> cachedInstances = new HashMap<>();43	private final TimeOutDuration duration;44	private final Map<ContentType, Constructor<? extends Widget>> instantiationMap;4546	WidgetInterceptor(CacheableLocator locator, WebDriver driver, WebElement cachedElement,47			Map<ContentType, Constructor<? extends Widget>> instantiationMap,48			TimeOutDuration duration) {49		super(locator, driver);50		this.cachedElement = cachedElement;51		this.instantiationMap = instantiationMap;52		this.duration = duration;53	}545556	@Override57	public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy)58			throws Throwable {59		if (locator != null) {60			return super.intercept(obj, method, args, proxy);61		}62		return getObject(cachedElement, method, args);63	}6465	@Override protected Object getObject(WebElement element, Method method, Object[] args)66			throws Throwable {67		ContentType type = getCurrentContentType(element);68		if (cachedElement == null69				|| locator != null && !((CacheableLocator) locator)70				.isLookUpCached()71				|| cachedInstances.size() == 0) {72			cachedElement = element;7374			Constructor<? extends Widget> constructor = instantiationMap.get(type);75			Class<? extends Widget> clazz = constructor.getDeclaringClass();7677			int modifiers = clazz.getModifiers();78			if (Modifier.isAbstract(modifiers)) {79				throw new InstantiationException(clazz.getName()80						+ " is abstract so "81						+ "it can't be instantiated");82			}83
...

LazyLocatorFactory.java

Source:LazyLocatorFactory.java

...8import io.appium.java_client.ios.IOSElement;9import io.appium.java_client.pagefactory.AppiumFieldDecorator;10import io.appium.java_client.pagefactory.TimeOutDuration;11import io.appium.java_client.pagefactory.Widget;12import io.appium.java_client.pagefactory.locator.CacheableLocator;13import io.appium.java_client.pagefactory.utils.ProxyFactory;14import io.appium.java_client.pagefactory.utils.WebDriverUnpackUtility;15import org.openqa.selenium.SearchContext;16import org.openqa.selenium.WebDriver;17import org.openqa.selenium.WebElement;18import org.openqa.selenium.remote.RemoteWebElement;19import org.openqa.selenium.support.pagefactory.DefaultFieldDecorator;20import org.openqa.selenium.support.pagefactory.ElementLocator;21import java.lang.reflect.Constructor;22import java.lang.reflect.Field;23import java.lang.reflect.ParameterizedType;24import java.lang.reflect.Type;25import java.util.*;26import java.util.concurrent.TimeUnit;...

WidgetListInterceptor.java

Source:WidgetListInterceptor.java

...30import io.appium.java_client.pagefactory.TimeOutDuration;31import io.appium.java_client.pagefactory.Widget;32import io.appium.java_client.pagefactory.bys.ContentType;33import io.appium.java_client.pagefactory.interceptors.InterceptorOfAListOfElements;34import io.appium.java_client.pagefactory.locator.CacheableLocator;35import io.appium.java_client.pagefactory.utils.ProxyFactory;3637class WidgetListInterceptor extends InterceptorOfAListOfElements {3839	private List<WebElement> cachedElements;40	private final List<Widget> cachedWidgets = new ArrayList<>();41	private final Class<? extends Widget> declaredType;42	private final WebDriver driver;43	private final TimeOutDuration duration;44	private final Map<ContentType, Constructor<? extends Widget>> instantiationMap;4546	WidgetListInterceptor(CacheableLocator locator, WebDriver driver,47			Map<ContentType, Constructor<? extends Widget>> instantiationMap,48			Class<? extends Widget> declaredType, TimeOutDuration duration) {49		super(locator);50		this.instantiationMap = instantiationMap;51		this.declaredType = declaredType;52		this.duration = duration;53		this.driver = driver;54	}555657	@Override protected Object getObject(List<WebElement> elements, Method method, Object[] args)58			throws Throwable {59		if (cachedElements == null || locator != null && !((CacheableLocator) locator)60				.isLookUpCached()) {61			cachedElements = elements;62			cachedWidgets.clear();6364			for (WebElement element : cachedElements) {65				ContentType type = getCurrentContentType(element);66				Class<?>[] params =67						new Class<?>[] {instantiationMap.get(type).getParameterTypes()[0]};68						cachedWidgets.add(ProxyFactory69								.getEnhancedProxy(declaredType, params, new Object[] {element},70										new WidgetInterceptor(null, driver, element, instantiationMap, duration)));71			}72		}73		try {
...

AppiumElementLocatorFactory.java

Source:AppiumElementLocatorFactory.java

...26import io.appium.java_client.pagefactory.TimeOutDuration;27import io.appium.java_client.pagefactory.WithTimeout;28import io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder;29import io.appium.java_client.pagefactory.locator.CacheableElementLocatorFactory;30import io.appium.java_client.pagefactory.locator.CacheableLocator;3132public class AppiumElementLocatorFactory implements CacheableElementLocatorFactory {33	private final AppiumByBuilder builder;34	private final WebDriver originalWebDriver;35	private final SearchContext searchContext;36	private final TimeOutDuration timeOutDuration;3738	public AppiumElementLocatorFactory(SearchContext searchContext, TimeOutDuration timeOutDuration,39			WebDriver originalWebDriver, AppiumByBuilder builder) {40		this.searchContext = searchContext;41		this.originalWebDriver = originalWebDriver;42		this.timeOutDuration = timeOutDuration;43		this.builder = builder;44	}4546	@Override public CacheableLocator createLocator(AnnotatedElement annotatedElement) {47		TimeOutDuration customDuration;48		if (annotatedElement.isAnnotationPresent(WithTimeout.class)) {49			WithTimeout withTimeout = annotatedElement.getAnnotation(WithTimeout.class);50			customDuration = new TimeOutDuration(withTimeout.time(), withTimeout.unit());51		} else {52			customDuration = timeOutDuration;53		}5455		builder.setAnnotated(annotatedElement);56		By by = builder.buildBy();57		if (by != null) {58			return new AppiumElementLocator(searchContext, by, builder.isLookupCached(),59					customDuration, timeOutDuration, originalWebDriver);60		}61		return null;62	}6364	@Override65	public CacheableLocator createLocator(Field field) {66		return this.createLocator((AnnotatedElement) field);67	}686970}
...

AIElementLocatorFactory.java

Source:AIElementLocatorFactory.java

2import java.lang.reflect.AnnotatedElement;3import java.lang.reflect.Field;4import org.openqa.selenium.SearchContext;5import io.appium.java_client.pagefactory.locator.CacheableElementLocatorFactory;6import io.appium.java_client.pagefactory.locator.CacheableLocator;7import org.openqa.selenium.WebDriver;8public class AIElementLocatorFactory implements CacheableElementLocatorFactory {9	10	private WebDriver driver;11	private SearchContext searchContext;12	public AIElementLocatorFactory(SearchContext searchContext) {13		this.searchContext = searchContext;14	}15	public AIElementLocatorFactory(WebDriver pDriver, SearchContext searchContext) {16		this.driver = pDriver;17		this.searchContext = searchContext;18	}19	@Override20    public CacheableLocator createLocator(Field field) {21        return new AIElementLocator(driver, searchContext, field);22    }23	@Override24	public CacheableLocator createLocator(AnnotatedElement annotatedElement) {25        return this.createLocator((Field) annotatedElement);26	}27}...

CacheableLocator

Using AI Code Generation

1@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/digit_3\")")2private MobileElement three;3@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/digit_4\")")4private MobileElement four;5@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/digit_5\")")6private MobileElement five;7@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/digit_6\")")8private MobileElement six;9@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/digit_7\")")10private MobileElement seven;11@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/digit_8\")")12private MobileElement eight;13@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/digit_9\")")14private MobileElement nine;15@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/digit_0\")")16private MobileElement zero;17@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/op_add\")")18private MobileElement plus;19@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/op_sub\")")20private MobileElement minus;21@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/op_mul\")")22private MobileElement multiply;23@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/op_div\")")24private MobileElement divide;25@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/eq\")")26private MobileElement equal;27@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/result\")")28private MobileElement results;29@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/clr\")")30private MobileElement clear;31@AndroidFindBy(uiAutomator = "new UiSelector().resourceId(\"com.android.calculator2:id/del\")")32private MobileElement delete;

CacheableLocator

Using AI Code Generation

1import org.openqa.selenium.WebElement;2import org.openqa.selenium.support.CacheLookup;3import org.openqa.selenium.support.FindBy;4import org.openqa.selenium.support.How;5public class CacheableLocatorTest {6    @FindBy(how = How.ID, using = "android:id/content")7    private WebElement content;8    @FindBy(how = How.ID, using = "android:id/text1")9    private WebElement text1;10    @FindBy(how = How.ID, using = "android:id/text2")11    private WebElement text2;12    @FindBy(how = How.ID, using = "android:id/button1")13    private WebElement button1;14    @FindBy(how = How.ID, using = "android:id/button2")15    private WebElement button2;16    @FindBy(how = How.ID, using = "android:id/button3")17    private WebElement button3;18    @FindBy(how = How.ID, using = "android:id/alertTitle")19    private WebElement alertTitle;20    @FindBy(how = How.ID, using = "android:id/message")21    private WebElement message;22    @FindBy(how = How.ID, using = "android:id/parentPanel")23    private WebElement parentPanel;24    @FindBy(how = How.ID, using = "android:id/topPanel")25    private WebElement topPanel;26    @FindBy(how = How.ID, using = "android:id/contentPanel")27    private WebElement contentPanel;28    @FindBy(how = How.ID, using = "android:id/customPanel")29    private WebElement customPanel;30    @FindBy(how = How.ID, using = "android:id/buttonPanel")31    private WebElement buttonPanel;32    @FindBy(how = How.ID, using = "android:id/scrollView")33    private WebElement scrollView;34    @FindBy(how = How.ID, using = "android:id/titleDivider")35    private WebElement titleDivider;36    @FindBy(how = How.ID, using = "android:id/titleDividerTop")37    private WebElement titleDividerTop;38    @FindBy(how = How.ID, using =

CacheableLocator

Using AI Code Generation

1@AndroidFindBy(className = "android.widget.TextView")2private MobileElement textView;3@AndroidFindBy(className = "android.widget.TextView")4private List<MobileElement> textViews;5public AppiumFieldDecorator(AppiumDriver driver) {6    this(driver, new TimeOutDuration(15, TimeUnit.SECONDS));7}8public AppiumFieldDecorator(AppiumDriver driver, TimeOutDuration duration) {9    this(driver, duration, true);10}11public AppiumFieldDecorator(AppiumDriver driver, TimeOutDuration duration, boolean enableAppiumAnnotations) {12    this(driver, duration, enableAppiumAnnotations, new DefaultElementByBuilder());13}14public AppiumFieldDecorator(AppiumDriver driver, TimeOutDuration duration, boolean enableAppiumAnnotations, ElementByBuilder builder) {15    this(driver, duration, enableAppiumAnnotations, builder, new DefaultElementLocatorFactory(driver));16}17public AppiumFieldDecorator(AppiumDriver driver, TimeOutDuration duration, boolean enableAppiumAnnotations, ElementByBuilder builder, ElementLocatorFactory factory) {18    this.driver = driver;19    this.duration = duration;20    this.enableAppiumAnnotations = enableAppiumAnnotations;21    this.builder = builder;22    this.factory = factory;23}24public Object decorate(ClassLoader loader, Field field) {25    if (!(WebElement.class.isAssignableFrom(field.getType()) || isDecoratableList(field))) {26        return null;27    }28    ElementLocator locator = factory.createLocator(field);29    if (locator == null) {30        return null;31    }32    if (enableAppiumAnnotations) {33        return proxyForLocator(loader, locator);34    } else {35        return proxyForBasicLocator(loader, locator);36    }37}

CacheableLocator

Using AI Code Generation

1@AndroidFindBy(uiAutomator = "new UiSelector().description(\"Search\")")2private MobileElement searchIcon;3@AndroidFindBy(uiAutomator = "new UiSelector().description(\"Search\")")4private MobileElement searchIcon;5@AndroidFindBy(uiAutomator = "new UiSelector().description(\"Search\")")6private MobileElement searchIcon;7@AndroidFindBy(uiAutomator = "new UiSelector().description(\"Search\")")8private MobileElement searchIcon;9@AndroidFindBy(uiAutomator = "new UiSelector().description(\"Search\")")10private MobileElement searchIcon;11@AndroidFindBy(uiAutomator = "new UiSelector().description(\"Search\")")12private MobileElement searchIcon;13@AndroidFindBy(uiAutomator = "new UiSelector().description(\"Search\")")14private MobileElement searchIcon;15@AndroidFindBy(uiAutomator = "new UiSelector().description(\"Search\")")16private MobileElement searchIcon;17@AndroidFindBy(uiAutomator = "new UiSelector().description(\"Search\")")18private MobileElement searchIcon;19@AndroidFindBy(uiAutomator = "new UiSelector().description(\"Search\")")20private MobileElement searchIcon;

CacheableLocator

Using AI Code Generation

1WebElement element = driver.findElement(MobileBy.iOSNsPredicateString("name='myName'"));2WebElement element = driver.findElement(MobileBy.iOSClassChain("**/XCUIElementTypeButton[`name == 'myName'`]"));3WebElement element = driver.findElement(MobileBy.AccessibilityId("myName"));4WebElement element = driver.findElement(MobileBy.AndroidUIAutomator("new UiSelector().text(\"myName\")"));5WebElement element = driver.findElement(MobileBy.AndroidViewTag("myName"));6WebElement element = driver.findElement(MobileBy.image("myName"));7WebElement element = driver.findElement(MobileBy.Custom("myName"));8WebElement element = driver.findElement(MobileBy.IosUIAutomation(".elements()[0]"));9WebElement element = driver.findElement(MobileBy.WindowsAutomation("myName"));

CacheableLocator

Using AI Code Generation

1import io.appium.java_client.android.AndroidDriver;2import io.appium.java_client.pagefactory.AppiumFieldDecorator;3import io.appium.java_client.pagefactory.CacheableLocator;4import io.appium.java_client.pagefactory.WithTimeout;5import org.openqa.selenium.WebElement;6import org.openqa.selenium.support.FindBy;7import org.openqa.selenium.support.PageFactory;8import java.time.temporal.ChronoUnit;9import java.util.concurrent.TimeUnit;10public class AppiumCacheableLocator {11    private AndroidDriver driver;12    @FindBy(id = "com.example.android.contactmanager:id/addContactButton")13    @WithTimeout(time = 10, chronoUnit = ChronoUnit.SECONDS)14    private CacheableLocator addContactButton;15    public AppiumCacheableLocator(AndroidDriver driver) {16        this.driver = driver;17        PageFactory.initElements(new AppiumFieldDecorator(driver, 10, TimeUnit.SECONDS), this);18    }19    public void clickAddContactButton() {20        addContactButton.findElement().click();21    }22}23from appium import webdriver24from appium.webdriver.common.mobileby import MobileBy25from selenium.webdriver.support import expected_conditions as EC26from selenium.webdriver.support.ui import WebDriverWait27from selenium.webdriver.support.ui import WebDriverWait28    def __init__(self):29        desired_caps = {}30    def click_add_contact_button(self):31        add_contact_button = self.driver.find_element_by_id("com.example.android.contactmanager:id/addContactButton")32        add_contact_button.click()33    def click_add_contact_button_with_cache(self):34        add_contact_button = self.driver.find_element_by_id("com.example.android.contactmanager:id/addContactButton")35        add_contact_button.click()36    def click_add_contact_button_with_cache_timeout(self):37        add_contact_button = self.driver.find_element_by_id("com.example.android.contactmanager:id/addContactButton")38        add_contact_button.click()

CacheableLocator

Using AI Code Generation

1@AndroidFindBy(id = "com.example:id/my_text_field")2public MobileElement myElement;3@iOSFindBy(id = "my_text_field")4public MobileElement myElement;5public MobileElement myElement;6public MobileElement myElement;7@AndroidFindBy(uiAutomator = "new UiSelector().text(\"my_text_field\")")8public MobileElement myElement;9@iOSFindBy(uiAutomator = ".elements()[0]")10public MobileElement myElement;11@AndroidFindBy(accessibility = "my_text_field")12public MobileElement myElement;13@iOSFindBy(accessibility = "my_text_field")14public MobileElement myElement;15@AndroidFindBy(className = "android.widget.TextView")16public MobileElement myElement;17@iOSFindBy(className = "XCUIElementTypeStaticText")18public MobileElement myElement;

CacheableLocator

Using AI Code Generation

1@AndroidFindBy(id = "com.example.android.apis:id/scroll")2public WebElement scroll;3@AndroidFindBy(id = "com.example.android.apis:id/scroll")4public WebElement scroll;5@AndroidFindBy(id = "com.example.android.apis:id/scroll")6public WebElement scroll;7@AndroidFindBy(id = "com.example.android.apis:id/scroll")8public WebElement scroll;9@AndroidFindBy(id = "com.example.android.apis:id/scroll")10public WebElement scroll;11@AndroidFindBy(id = "com.example.android.apis:id/scroll")12public WebElement scroll;13@AndroidFindBy(id = "com.example.android.apis:id/scroll")14public WebElement scroll;15@AndroidFindBy(id = "com.example.android.apis:id/scroll")16public WebElement scroll;17@AndroidFindBy(id = "com.example.android.apis:id/scroll")18public WebElement scroll;19@AndroidFindBy(id = "com.example.android.apis:id/scroll")20public WebElement scroll;

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.