support/test/InstrumentationRegistry.html

<!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>InstrumentationRegistry</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="#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">InstrumentationRegistry</h1>
<p>
<code class="api-signature">
  public

  final

  class
  InstrumentationRegistry
</code>
<br>


<code class="api-signature">

    extends Object


</code>

<code class="api-signature">


</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.InstrumentationRegistry
    </td>
  </tr>


</table>


<br><hr>


  <p>An exposed registry instance that holds a reference to the instrumentation running in the
 process and it's arguments. Also provides an easy way for callers to get a hold of
 instrumentation, application context and instrumentation arguments Bundle.
</p>


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


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


  <tr class="api apilevel-" >


    <td><code>


        static


        Bundle</code>
    </td>

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

        <p>Returns a copy of instrumentation arguments Bundle.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        static


        Context</code>
    </td>

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

        <p>Return the Context of this instrumentation's package.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        static


        Instrumentation</code>
    </td>

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

        <p>Returns the instrumentation currently running.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        static


        Context</code>
    </td>

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

        <p>Return a Context for the target application being instrumented.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        static


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/InstrumentationRegistry.html#registerInstance(android.app.Instrumentation, android.os.Bundle)">registerInstance</a>(Instrumentation instrumentation, Bundle arguments)
      </code>

        <p>Records/exposes the instrumentation currently running and stores a copy of the
 instrumentation arguments Bundle in the registry.


</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>


</table>


<!-- XML Attributes -->


<!-- Enum Values -->


<!-- Constants -->


<!-- Fields -->


<!-- Public ctors -->


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


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

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


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

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


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


  <p>Returns a copy of instrumentation arguments Bundle. Use this to get a <code><a href="/reference/android/os/Bundle.html">Bundle</a></code>
 containing the command line arguments passed to <code><a href="/reference/android/app/Instrumentation.html">Instrumentation</a></code> into your test.
 <p>
 This Bundle is not guaranteed to be present under all instrumentations.
 </p></p>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>Bundle</code></td>
        <td width="100%">Bundle the arguments for this instrumentation.</td>
      </tr>
    </table>
      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code>IllegalStateException</code></td>
          <td width="100%">if no argument Bundle has been registered.
</td>
        </tr>
      </table>


</div>


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

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


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


  <p>Return the Context of this instrumentation's package. Use this to get a
 <code><a href="/reference/android/content/Context.html">Context</a></code> representing <code><a href="/reference/android/app/Instrumentation.html#getContext()">getContext()</a></code> into your test.
</p>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>Context</code></td>
        <td width="100%"><!-- no returns description in source --></td>
      </tr>
    </table>

</div>


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

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


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


  <p>Returns the instrumentation currently running. Use this to get an <code><a href="/reference/android/app/Instrumentation.html">Instrumentation</a></code>
 into your test.</p>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>Instrumentation</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>IllegalStateException</code></td>
          <td width="100%">if instrumentation hasn't been registered
</td>
        </tr>
      </table>


</div>


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

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


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


  <p>Return a Context for the target application being instrumented. Use this to get a
 <code><a href="/reference/android/content/Context.html">Context</a></code> representing <code><a href="/reference/android/app/Instrumentation.html#getTargetContext()">getTargetContext()</a></code> into your test.
</p>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>Context</code></td>
        <td width="100%"><!-- no returns description in source --></td>
      </tr>
    </table>

</div>


<A NAME="registerInstance(android.app.Instrumentation, android.os.Bundle)"></A>

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


    </div>
<pre class="api-signature no-pretty-print">
void registerInstance (Instrumentation instrumentation,
                Bundle arguments)</pre>


  <p>Records/exposes the instrumentation currently running and stores a copy of the
 instrumentation arguments Bundle in the registry.
 <p>
 This is a global registry - so be aware of the impact of calling this method!
 </p></p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>instrumentation</code></td>
        <td width="100%">
          <code>Instrumentation</code>:
          the instrumentation currently running.</td>
      </tr>
      <tr>
        <td><code>arguments</code></td>
        <td width="100%">
          <code>Bundle</code>:
          the arguments for this application. Null deregisters any existing arguments.
</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/InstrumentationRegistry.html">InstrumentationRegistry</a></li>
      </ul>
    </li>


  </ul>

</div>


</body>
</html>