android-7.1.0_r7/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>DisableOnAndroidDebug</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">DisableOnAndroidDebug</h1>
<p>
<code class="api-signature">
  public


  class
  DisableOnAndroidDebug
</code>
<br>


<code class="api-signature">

    extends Object


</code>

<code class="api-signature">


      implements

        TestRule


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


</table>


<br><hr>


  <p>The <code>DisableOnAndroidDebug</code> Rule allows you to label certain rules to be
 disabled when debugging.
 <p>
 The most illustrative use case is for tests that make use of the
 <a href="http://junit.org/apidocs/org/junit/rules/Timeout.html"><code>Timeout</code></a>
 rule, when ran in debug mode the test may terminate on
 timeout abruptly during debugging. Developers may disable the timeout, or
 increase the timeout by making a code change on tests that need debugging and
 remember revert the change afterwards or rules such as
 <a href="http://junit.org/apidocs/org/junit/rules/Timeout.html"><code>Timeout</code></a> that
 may be disabled during debugging may be wrapped in a <code>DisableOnDebug</code>.
 <p>
 The important benefit of this feature is that you can disable such rules
 without any making any modifications to your test class to remove them during
 debugging.
 <p>
 This does nothing to tackle timeouts or time sensitive code under test when
 debugging and may make this less useful in such circumstances.
 <p>
 Example usage:

 <pre>
 public static class DisableTimeoutOnDebugSampleTest {

     &#064;Rule
     public TestRule timeout = new DisableOnAndroidDebug(new Timeout(20));

     &#064;Test
     public void myTest() {
         int i = 0;
         assertEquals(0, i); // suppose you had a break point here to inspect i
     }
 }
 </pre>
</p>


<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/rule/DisableOnAndroidDebug.html#DisableOnAndroidDebug(org.junit.rules.TestRule)">DisableOnAndroidDebug</a>(TestRule rule)
      </code>

        <p>Wrap another <code><a href="/reference/org/junit/rules/TestRule.html">TestRule</a></code> and conditionally disable it when a debugger is attached.


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


        final

        Statement</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/rule/DisableOnAndroidDebug.html#apply(org.junit.runners.model.Statement, org.junit.runner.Description)">apply</a>(Statement base, Description description)
      </code>

        <p>


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

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

        <p>Returns <code>true</code> if the VM has a debugger connected.


</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-org.junit.rules.TestRule" class="jd-expando-trigger closed"
          ><img height="34" id="inherited-methods-org.junit.rules.TestRule-trigger"
          src="/assets/images/styles/disclosure_down.png"
          class="jd-expando-trigger-img" /></a>From
interface
<code>

    org.junit.rules.TestRule

</code>
<div id="inherited-methods-org.junit.rules.TestRule">
  <div id="inherited-methods-org.junit.rules.TestRule-list"
        class="jd-inheritedlinks">
  </div>
  <div id="inherited-methods-org.junit.rules.TestRule-summary" style="display: none;">
    <table class="jd-sumtable-expando responsive">


  <tr class="api apilevel-" >


    <td><code>
        abstract


        Statement</code>
    </td>

    <td width="100%">
      <code>
      apply(Statement arg0, Description arg1)
      </code>

    </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="DisableOnAndroidDebug(org.junit.rules.TestRule)"></A>

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


    </div>
<pre class="api-signature no-pretty-print">
DisableOnAndroidDebug (TestRule rule)</pre>


  <p>Wrap another <code><a href="/reference/org/junit/rules/TestRule.html">TestRule</a></code> and conditionally disable it when a debugger is attached.</p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>rule</code></td>
        <td width="100%">
          <code>TestRule</code>:
          to disable during debugging
</td>
      </tr>
    </table>

</div>


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


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

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


<A NAME="apply(org.junit.runners.model.Statement, org.junit.runner.Description)"></A>

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


    </div>
<pre class="api-signature no-pretty-print">
Statement apply (Statement base,
                Description description)</pre>


  <p>
</p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>base</code></td>
        <td width="100%">
          <code>Statement</code>
          <!-- no parameter comment --></td>
      </tr>
      <tr>
        <td><code>description</code></td>
        <td width="100%">
          <code>Description</code>
          <!-- no parameter comment --></td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>Statement</code></td>
        <td width="100%"><!-- no returns description in source --></td>
      </tr>
    </table>

</div>


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

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


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


  <p>Returns <code>true</code> if the VM has a debugger connected. This method may be used by test
 classes to take additional action to disable code paths that interfere with debugging if
 required.</p>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%"><code>true</code> if a debugger is connected, <code>false</code> otherwise
</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="api apilevel-"><a href="/reference/android/support/test/rule/ActivityTestRule.html">ActivityTestRule</a></li>
          <li class="selected api apilevel-"><a href="/reference/android/support/test/rule/DisableOnAndroidDebug.html">DisableOnAndroidDebug</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/rule/ServiceTestRule.html">ServiceTestRule</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/rule/UiThreadTestRule.html">UiThreadTestRule</a></li>
      </ul>
    </li>


  </ul>

</div>


</body>
</html>