android-7.0.0_r1/s

<!DOCTYPE html>
<html devsite>
<head>


    <meta name="top_category" value="develop" />

    <meta name="subcategory" value="reference" />


      <meta name="book_path" value="/reference/android/support/test/_book.yaml" />


<title>AtomAction</title>


</head>

<body class="gc-documentation develop reference api apilevel-">
<div id="doc-api-level" class="" style="display:none"></div>


<div id="naMessage"></div>

<div id="api-info-block">
<div class="api-level">


</div>


<div class="sum-details-links">

Summary:


  <a href="#pubctors">Ctors</a>


  &#124; <a href="#pubmethods">Methods</a>


  &#124; <a href="#inhmethods">Inherited Methods</a>

&#124; <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a>

</div><!-- end sum-details-links -->
</div><!-- end api-info-block -->

<div class="api apilevel-" id="jd-content">

<!-- ======== START OF CLASS DATA ======== -->

<h1 class="api-title">AtomAction</h1>
<p>
<code class="api-signature">
  public

  final

  class
  AtomAction
</code>
<br>


<code class="api-signature">

    extends Object


</code>

<code class="api-signature">


      implements

        <a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a>


</code>

</p><table class="jd-inheritance-table">


  <tr>

    <td colspan="2" class="jd-inheritance-class-cell">java.lang.Object
    </td>
  </tr>


  <tr>

      <td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;&#x21b3;</td>

    <td colspan="1" class="jd-inheritance-class-cell">android.support.test.espresso.web.action.AtomAction&lt;E&gt;
    </td>
  </tr>


</table>


<br><hr>


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

 <p>It is not recommended to use AtomAction directly.
 <p>Instead  for
 examples of how to interact with a WebView's content through Atoms.
 <p>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.</p>


  <div>
      <p><b>See also:</b></p>
      <ul class="nolist"><li><code><a href="/reference/android/support/test/espresso/web/sugar/Web.html">Web</a></code></li>
      </ul>
  </div>


<h2 class="api-section">Summary</h2>


<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<table id="pubctors" class="responsive constructors">
<tr><th colspan="2"><h3>Public constructors</h3></th></tr>


  <tr class="api apilevel-" >


    <td width="100%">
      <code>
      <a href="/reference/android/support/test/espresso/web/action/AtomAction.html#AtomAction(android.support.test.espresso.web.model.Atom<E>, android.support.test.espresso.web.model.WindowReference, android.support.test.espresso.web.model.ElementReference)">AtomAction</a>(<a href="/reference/android/support/test/espresso/web/model/Atom.html">Atom</a>&lt;E&gt; atom, <a href="/reference/android/support/test/espresso/web/model/WindowReference.html">WindowReference</a> window, <a href="/reference/android/support/test/espresso/web/model/ElementReference.html">ElementReference</a> element)
      </code>

        <p>Creates an AtomAction.


</p>

    </td>
  </tr>


</table>


<!-- ========== METHOD SUMMARY =========== -->
<table id="pubmethods" class="responsive methods">
<tr><th colspan="2"><h3>Public methods</h3></th></tr>


  <tr class="api apilevel-" >


    <td><code>


        E</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/espresso/web/action/AtomAction.html#get(long, java.util.concurrent.TimeUnit)">get</a>(long val, TimeUnit unit)
      </code>

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


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        E</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/espresso/web/action/AtomAction.html#get()">get</a>()
      </code>

        <p>Blocks until the atom has completed execution.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        Matcher&lt;View&gt;</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/espresso/web/action/AtomAction.html#getConstraints()">getConstraints</a>()
      </code>

        <p>A mechanism for ViewActions to specify what type of views they can operate on.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        String</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/espresso/web/action/AtomAction.html#getDescription()">getDescription</a>()
      </code>

        <p>Returns a description of the view action.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        Future&lt;E&gt;</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/espresso/web/action/AtomAction.html#getFuture()">getFuture</a>()
      </code>

        <p>Return a Future, which will be set and transformed from futureEval.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/espresso/web/action/AtomAction.html#perform(android.support.test.espresso.UiController, android.view.View)">perform</a>(<a href="/reference/android/support/test/espresso/UiController.html">UiController</a> controller, View view)
      </code>

        <p>Performs this action on the given view.


</p>

    </td>
  </tr>


</table>


<!-- ========== METHOD SUMMARY =========== -->
<table id="inhmethods" class="methods inhtable">
<tr><th><h3>Inherited methods</h3></th></tr>


<tr class="api apilevel-" >
<td colspan="2">

  <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Object" class="jd-expando-trigger closed"
          ><img height="34" id="inherited-methods-java.lang.Object-trigger"
          src="/assets/images/styles/disclosure_down.png"
          class="jd-expando-trigger-img" /></a>From
class
<code>

    java.lang.Object

</code>
<div id="inherited-methods-java.lang.Object">
  <div id="inherited-methods-java.lang.Object-list"
        class="jd-inheritedlinks">
  </div>
  <div id="inherited-methods-java.lang.Object-summary" style="display: none;">
    <table class="jd-sumtable-expando responsive">


  <tr class="api apilevel-" >


    <td><code>


        Object</code>
    </td>

    <td width="100%">
      <code>
      clone()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      equals(Object arg0)
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      finalize()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        Class&lt;?&gt;</code>
    </td>

    <td width="100%">
      <code>
      getClass()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        int</code>
    </td>

    <td width="100%">
      <code>
      hashCode()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      notify()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      notifyAll()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        String</code>
    </td>

    <td width="100%">
      <code>
      toString()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      wait(long arg0, int arg1)
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      wait(long arg0)
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      wait()
      </code>

    </td>
  </tr>


    </table>
  </div>
</div>
</td></tr>


<tr class="api apilevel-" >
<td colspan="2">

  <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-android.support.test.espresso.ViewAction" class="jd-expando-trigger closed"
          ><img height="34" id="inherited-methods-android.support.test.espresso.ViewAction-trigger"
          src="/assets/images/styles/disclosure_down.png"
          class="jd-expando-trigger-img" /></a>From
interface
<code>

    <a href="/reference/android/support/test/espresso/ViewAction.html">android.support.test.espresso.ViewAction</a>

</code>
<div id="inherited-methods-android.support.test.espresso.ViewAction">
  <div id="inherited-methods-android.support.test.espresso.ViewAction-list"
        class="jd-inheritedlinks">
  </div>
  <div id="inherited-methods-android.support.test.espresso.ViewAction-summary" style="display: none;">
    <table class="jd-sumtable-expando responsive">


  <tr class="api apilevel-" >


    <td><code>
        abstract


        Matcher&lt;View&gt;</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/espresso/ViewAction.html#getConstraints()">getConstraints</a>()
      </code>

        <p>A mechanism for ViewActions to specify what type of views they can operate on.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>
        abstract


        String</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/espresso/ViewAction.html#getDescription()">getDescription</a>()
      </code>

        <p>Returns a description of the view action.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>
        abstract


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/espresso/ViewAction.html#perform(android.support.test.espresso.UiController, android.view.View)">perform</a>(<a href="/reference/android/support/test/espresso/UiController.html">UiController</a> uiController, View view)
      </code>

        <p>Performs this action on the given view.


</p>

    </td>
  </tr>


    </table>
  </div>
</div>
</td></tr>


</table>


<!-- XML Attributes -->


<!-- Enum Values -->


<!-- Constants -->


<!-- Fields -->


<!-- Public ctors -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->
<h2 class="api-section">Public constructors</h2>


<A NAME="AtomAction(android.support.test.espresso.web.model.Atom<E>, android.support.test.espresso.web.model.WindowReference, android.support.test.espresso.web.model.ElementReference)"></A>

<div class="api apilevel-">
    <h3 class="api-name">AtomAction</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
AtomAction (<a href="/reference/android/support/test/espresso/web/model/Atom.html">Atom</a>&lt;E&gt; atom,
                <a href="/reference/android/support/test/espresso/web/model/WindowReference.html">WindowReference</a> window,
                <a href="/reference/android/support/test/espresso/web/model/ElementReference.html">ElementReference</a> element)</pre>


  <p>Creates an AtomAction.</p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>atom</code></td>
        <td width="100%">
          <code>Atom</code>:
          the atom to execute</td>
      </tr>
      <tr>
        <td><code>window</code></td>
        <td width="100%">
          <code>WindowReference</code>:
          (optional/nullable) the window context to execute on.</td>
      </tr>
      <tr>
        <td><code>element</code></td>
        <td width="100%">
          <code>ElementReference</code>:
          (optional/nullable) the element to execute on.
</td>
      </tr>
    </table>

</div>


<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- Protected ctors -->


<!-- ========= METHOD DETAIL ======== -->
<!-- Public methdos -->

<h2 class="api-section">Public methods</h2>


<A NAME="get(long, java.util.concurrent.TimeUnit)"></A>

<div class="api apilevel-">
    <h3 class="api-name">get</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
E get (long val,
                TimeUnit unit)</pre>


  <p>Blocks until the atom has completed execution with a configurable timeout.
</p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>val</code></td>
        <td width="100%">
          <code>long</code>
          <!-- no parameter comment --></td>
      </tr>
      <tr>
        <td><code>unit</code></td>
        <td width="100%">
          <code>TimeUnit</code>
          <!-- no parameter comment --></td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>E</code></td>
        <td width="100%"><!-- no returns description in source --></td>
      </tr>
    </table>
      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code>ExecutionException</code></td>
          <td width="100%"></td>
        </tr>
        <tr>
          <td><code>InterruptedException</code></td>
          <td width="100%"></td>
        </tr>
        <tr>
          <td><code>TimeoutException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<A NAME="get()"></A>

<div class="api apilevel-">
    <h3 class="api-name">get</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
E get ()</pre>


  <p>Blocks until the atom has completed execution.
</p>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>E</code></td>
        <td width="100%"><!-- no returns description in source --></td>
      </tr>
    </table>
      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code>ExecutionException</code></td>
          <td width="100%"></td>
        </tr>
        <tr>
          <td><code>InterruptedException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<A NAME="getConstraints()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getConstraints</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
Matcher&lt;View&gt; getConstraints ()</pre>


  <p>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.</p>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>Matcher&lt;View&gt;</code></td>
        <td width="100%">a <a href="http://hamcrest.org/JavaHamcrest/javadoc/1.3/org/hamcrest/Matcher.html">
     <code>Matcher</code></a> that will be tested prior to calling perform.
</td>
      </tr>
    </table>

</div>


<A NAME="getDescription()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getDescription</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
String getDescription ()</pre>


  <p>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 ..."
</p>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>String</code></td>
        <td width="100%"><!-- no returns description in source --></td>
      </tr>
    </table>

</div>


<A NAME="getFuture()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getFuture</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
Future&lt;E&gt; getFuture ()</pre>


  <p>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.
</p>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>Future&lt;E&gt;</code></td>
        <td width="100%"><!-- no returns description in source --></td>
      </tr>
    </table>

</div>


<A NAME="perform(android.support.test.espresso.UiController, android.view.View)"></A>

<div class="api apilevel-">
    <h3 class="api-name">perform</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void perform (<a href="/reference/android/support/test/espresso/UiController.html">UiController</a> controller,
                View view)</pre>


  <p>Performs this action on the given view.</p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>controller</code></td>
        <td width="100%">
          <code>UiController</code>:
          the controller to use to interact with the UI.</td>
      </tr>
      <tr>
        <td><code>view</code></td>
        <td width="100%">
          <code>View</code>:
          the view to act upon. never null.
</td>
      </tr>
    </table>

</div>


<!-- ========= METHOD DETAIL ======== -->


<!-- ========= END OF CLASS DATA ========= -->

</div><!-- end jd-content -->


<div class="data-reference-resources-wrapper">

  <ul data-reference-resources>


    <li><h2>Classes</h2>
      <ul>
          <li class="selected api apilevel-"><a href="/reference/android/support/test/espresso/web/action/AtomAction.html">AtomAction</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/espresso/web/action/EnableJavascriptAction.html">EnableJavascriptAction</a></li>
      </ul>
    </li>


  </ul>

</div>


</body>
</html>