public final class

AtomAction

extends Object
implements ViewAction
java.lang.Object
   ↳ android.support.test.espresso.web.action.AtomAction<E>

Class Overview

A ViewAction which causes the provided Atom to be evaluated within a webview.

It is not recommended to use AtomAction directly.

Instead for examples of how to interact with a WebView's content through Atoms.

If you must use AtomAction directly, take care to remember that they are Stateful (unlike most ViewActions) and the caller must call {@ #get()} to ensure that the action has completed.

See Also

Summary

Public Constructors
AtomAction(Atom<E> atom, WindowReference window, ElementReference element)
Creates an AtomAction.
Public Methods
E get()
Blocks until the atom has completed execution.
E get(long val, TimeUnit unit)
Blocks until the atom has completed execution with a configurable timeout.
Matcher<View> getConstraints()
A mechanism for ViewActions to specify what type of views they can operate on.
String getDescription()
Returns a description of the view action.
Future<E> getFuture()
Return a Future, which will be set and transformed from futureEval.
void perform(UiController controller, View view)
Performs this action on the given view.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.support.test.espresso.ViewAction

Public Constructors

public AtomAction (Atom<E> atom, WindowReference window, ElementReference element)

Creates an AtomAction.

Parameters
atom the atom to execute
window (optional/nullable) the window context to execute on.
element (optional/nullable) the element to execute on.

Public Methods

public E get ()

Blocks until the atom has completed execution.

Throws
ExecutionException
InterruptedException

public E get (long val, TimeUnit unit)

Blocks until the atom has completed execution with a configurable timeout.

Throws
ExecutionException
InterruptedException
TimeoutException

public Matcher<View> getConstraints ()

A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is of a certain type.

Returns
  • a Matcher that will be tested prior to calling perform.

public String getDescription ()

Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..."

public Future<E> getFuture ()

Return a Future, which will be set and transformed from futureEval. Espresso's public API cannot have guava types in its method signatures, so return Future instead of ListenableFuture or SettableFuture.

public void perform (UiController controller, View view)

Performs this action on the given view.

Parameters
controller the controller to use to interact with the UI.
view the view to act upon. never null.