io.appium.droiddriver.base

Class BaseDroidDriver<R,E extends BaseUiElement<R,E>>

java.lang.Object

io.appium.droiddriver.base.BaseDroidDriver<R,E>

All Implemented Interfaces:

DroidDriver

Direct Known Subclasses:

InstrumentationDriver, UiAutomationDriver

public abstract class BaseDroidDriver<R,E extends BaseUiElement<R,E>>
extends java.lang.Object
implements DroidDriver

Base DroidDriver that implements the common operations.

Constructor Summary

Constructors

Constructor and Description
BaseDroidDriver()

Method Summary

Modifier and Type	Method and Description
void	checkExists(Finder finder) Polls until a UiElement is found using the given finder, or the default timeout is reached.
void	checkGone(Finder finder) Polls until the UiElement found using the given finder is gone, or the default timeout is reached.
boolean	dumpUiElementTree(java.lang.String path) Dumps the UiElement tree to a file to help debug.
UiElement	find(Finder finder) Returns the first UiElement found using the given finder without polling and without DroidDriver.refreshUiElementTree().
abstract InputInjector	getInjector()
Poller	getPoller() Returns the Poller.
E	getRootElement()
boolean	has(Finder finder) Returns whether a matching element exists without polling.
boolean	has(Finder finder, long timeoutMillis) Returns whether a matching element appears within timeoutMillis.
protected abstract E	newRootElement()
protected abstract E	newUiElement(R rawElement, E parent) Returns a new UiElement of type E.
UiElement	on(Finder finder) Returns the first UiElement found using the given finder.
void	refreshUiElementTree() Refreshes the UiElement tree.
void	setPoller(Poller poller) Sets the Poller.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.appium.droiddriver.DroidDriver

getUiDevice

Constructor Detail

BaseDroidDriver

public BaseDroidDriver()

Method Detail

find

public UiElement find(Finder finder)

Description copied from interface: DroidDriver

Returns the first UiElement found using the given finder without polling and without DroidDriver.refreshUiElementTree(). This method is useful in Poller.PollingListener.onPolling(io.appium.droiddriver.DroidDriver, io.appium.droiddriver.finders.Finder). In other situations polling is desired, and DroidDriver.on(io.appium.droiddriver.finders.Finder) is more appropriate.

Specified by:

find in interface DroidDriver

Parameters:

finder - The matching mechanism

Returns:

The first matching element

has

public boolean has(Finder finder)

Description copied from interface: DroidDriver

Returns whether a matching element exists without polling. Use this if the UI is not in the progress of updating.

Specified by:

has in interface DroidDriver

has

public boolean has(Finder finder,
                   long timeoutMillis)

Description copied from interface: DroidDriver

Returns whether a matching element appears within timeoutMillis. Use this only if you have no way to determine the content of current page. There are very few occasions using this is justified. For instance, you are looking for UiElements in a scrollable view, whose content varies based on the scroll position. Refrain from using this method in these cases:

• You know one of a set of UiElements will show, but are not sure which one. Use this instead:

   UiElement el = driver.on(By.anyOf(finder1, finder2, ...));
   // UI is stable now, find which one is returned
   if (finder1.matches(el)) ...
   

• You know the UiElement will appear, and want to optimize the speed by using a smaller timeout than the default timeout. It's not worth it -- on and checkExists return as soon as the finder is found. If it is not found, that's a test failure and should be rare.

Specified by:

has in interface DroidDriver

on

public UiElement on(Finder finder)

Description copied from interface: DroidDriver

Returns the first UiElement found using the given finder. This method will poll until a match is found, or the default timeout is reached.

Specified by:

on in interface DroidDriver

Parameters:

finder - The matching mechanism

Returns:

The first matching element

checkExists

public void checkExists(Finder finder)

Description copied from interface: DroidDriver

Polls until a UiElement is found using the given finder, or the default timeout is reached. This behaves the same as DroidDriver.on(io.appium.droiddriver.finders.Finder) except that it does not return the UiElement.

Specified by:

checkExists in interface DroidDriver

Parameters:

finder - The matching mechanism

checkGone

public void checkGone(Finder finder)

Description copied from interface: DroidDriver

Polls until the UiElement found using the given finder is gone, or the default timeout is reached.

Specified by:

checkGone in interface DroidDriver

Parameters:

finder - The matching mechanism

getPoller

public Poller getPoller()

Description copied from interface: DroidDriver

Returns the Poller.

Specified by:

getPoller in interface DroidDriver

setPoller

public void setPoller(Poller poller)

Description copied from interface: DroidDriver

Sets the Poller.

Specified by:

setPoller in interface DroidDriver

getInjector

public abstract InputInjector getInjector()

newRootElement

protected abstract E newRootElement()

newUiElement

protected abstract E newUiElement(R rawElement,
                                  E parent)

Returns a new UiElement of type E.

getRootElement

public E getRootElement()

refreshUiElementTree

public void refreshUiElementTree()

Description copied from interface: DroidDriver

Refreshes the UiElement tree. All methods in this interface that take a Finder parameter call this method, unless noted otherwise.

Specified by:

refreshUiElementTree in interface DroidDriver

dumpUiElementTree

public boolean dumpUiElementTree(java.lang.String path)

Description copied from interface: DroidDriver

Dumps the UiElement tree to a file to help debug. The tree is based on the last used root UiElement if it exists, otherwise DroidDriver.refreshUiElementTree() is called.

The dump may contain invisible UiElements that are not used in the finding algorithm.

Specified by:

dumpUiElementTree in interface DroidDriver

Parameters:

path - the path of file to save the tree

Returns:

whether the dumping succeeded