| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ControlsInjector (Drill : 1.20.3 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ControlsInjector (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ControlsInjector.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/drill/exec/testing/ControlsInjectorFactory.html" title="class in org.apache.drill.exec.testing"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/drill/exec/testing/ControlsInjector.html" target="_top">Frames</a></li> |
| <li><a href="ControlsInjector.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.drill.exec.testing</div> |
| <h2 title="Interface ControlsInjector" class="title">Interface ControlsInjector</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/drill/exec/testing/ExecutionControlsInjector.html" title="class in org.apache.drill.exec.testing">ExecutionControlsInjector</a>, <a href="../../../../../org/apache/drill/exec/testing/NoOpControlsInjector.html" title="class in org.apache.drill.exec.testing">NoOpControlsInjector</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ControlsInjector</span></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/testing/CountDownLatchInjection.html" title="interface in org.apache.drill.exec.testing">CountDownLatchInjection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/testing/ControlsInjector.html#getLatch-org.apache.drill.exec.testing.ExecutionControls-java.lang.String-">getLatch</a></span>(<a href="../../../../../org/apache/drill/exec/testing/ExecutionControls.html" title="class in org.apache.drill.exec.testing">ExecutionControls</a> executionControls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc)</code> |
| <div class="block">Used to insert a latch in site class.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/testing/ControlsInjector.html#getSiteClass--">getSiteClass</a></span>()</code> |
| <div class="block">Get the injector's owning class.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>><br>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/testing/ControlsInjector.html#injectChecked-org.apache.drill.exec.testing.ExecutionControls-java.lang.String-java.lang.Class-">injectChecked</a></span>(<a href="../../../../../org/apache/drill/exec/testing/ExecutionControls.html" title="class in org.apache.drill.exec.testing">ExecutionControls</a> executionControls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> exceptionClass)</code> |
| <div class="block">Inject (throw) a checked exception at this point, if an injection is specified, and it is time |
| for it to be thrown.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/testing/ControlsInjector.html#injectInterruptiblePause-org.apache.drill.exec.testing.ExecutionControls-java.lang.String-org.slf4j.Logger-">injectInterruptiblePause</a></span>(<a href="../../../../../org/apache/drill/exec/testing/ExecutionControls.html" title="class in org.apache.drill.exec.testing">ExecutionControls</a> executionControls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| org.slf4j.Logger logger)</code> |
| <div class="block">Insert a pause that can be interrupted using <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#interrupt--" title="class or interface in java.lang"><code>Thread.interrupt()</code></a> at the given site point, if such an |
| injection is specified (i.e.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/testing/ControlsInjector.html#injectPause-org.apache.drill.exec.testing.ExecutionControls-java.lang.String-org.slf4j.Logger-">injectPause</a></span>(<a href="../../../../../org/apache/drill/exec/testing/ExecutionControls.html" title="class in org.apache.drill.exec.testing">ExecutionControls</a> executionControls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| org.slf4j.Logger logger)</code> |
| <div class="block">Pauses at this point, if such an injection is specified (i.e.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/testing/ControlsInjector.html#injectUnchecked-org.apache.drill.exec.testing.ExecutionControls-java.lang.String-">injectUnchecked</a></span>(<a href="../../../../../org/apache/drill/exec/testing/ExecutionControls.html" title="class in org.apache.drill.exec.testing">ExecutionControls</a> executionControls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc)</code> |
| <div class="block">Inject (throw) an unchecked exception at this point, if an injection is specified, and it is time |
| for it to be thrown.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getSiteClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSiteClass</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> getSiteClass()</pre> |
| <div class="block">Get the injector's owning class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the injector's owning class</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="injectUnchecked-org.apache.drill.exec.testing.ExecutionControls-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>injectUnchecked</h4> |
| <pre>void injectUnchecked(<a href="../../../../../org/apache/drill/exec/testing/ExecutionControls.html" title="class in org.apache.drill.exec.testing">ExecutionControls</a> executionControls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc)</pre> |
| <div class="block">Inject (throw) an unchecked exception at this point, if an injection is specified, and it is time |
| for it to be thrown. |
| <p/> |
| <p>Implementors use this in their code at a site where they want to simulate an exception |
| during testing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executionControls</code> - the controls in the current context</dd> |
| <dd><code>desc</code> - the site descriptor |
| throws the exception specified by the injection, if it is time</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="injectChecked-org.apache.drill.exec.testing.ExecutionControls-java.lang.String-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>injectChecked</h4> |
| <pre><T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>> void injectChecked(<a href="../../../../../org/apache/drill/exec/testing/ExecutionControls.html" title="class in org.apache.drill.exec.testing">ExecutionControls</a> executionControls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> exceptionClass) |
| throws T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></pre> |
| <div class="block">Inject (throw) a checked exception at this point, if an injection is specified, and it is time |
| for it to be thrown. |
| <p/> |
| <p>Implementors use this in their code at a site where they want to simulate an exception |
| during testing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executionControls</code> - the controls in the current context</dd> |
| <dd><code>desc</code> - the site descriptor</dd> |
| <dd><code>exceptionClass</code> - the expected class of the exception (or a super class of it)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>T</code> - the exception specified by the injection, if it is time</dd> |
| <dd><code>T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="injectPause-org.apache.drill.exec.testing.ExecutionControls-java.lang.String-org.slf4j.Logger-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>injectPause</h4> |
| <pre>void injectPause(<a href="../../../../../org/apache/drill/exec/testing/ExecutionControls.html" title="class in org.apache.drill.exec.testing">ExecutionControls</a> executionControls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| org.slf4j.Logger logger)</pre> |
| <div class="block">Pauses at this point, if such an injection is specified (i.e. matches the site description). |
| <p/> |
| <p>Implementors use this in their code at a site where they want to simulate a pause |
| during testing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executionControls</code> - the controls in the current context</dd> |
| <dd><code>desc</code> - the site descriptor</dd> |
| <dd><code>logger</code> - logger of the class containing the injection site</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="injectInterruptiblePause-org.apache.drill.exec.testing.ExecutionControls-java.lang.String-org.slf4j.Logger-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>injectInterruptiblePause</h4> |
| <pre>void injectInterruptiblePause(<a href="../../../../../org/apache/drill/exec/testing/ExecutionControls.html" title="class in org.apache.drill.exec.testing">ExecutionControls</a> executionControls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| org.slf4j.Logger logger) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> |
| <div class="block">Insert a pause that can be interrupted using <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#interrupt--" title="class or interface in java.lang"><code>Thread.interrupt()</code></a> at the given site point, if such an |
| injection is specified (i.e. matches the site description). |
| <p/> |
| <p>Implementors use this in their code at a site where they want to simulate a interruptible pause |
| during testing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executionControls</code> - the controls in the current context</dd> |
| <dd><code>desc</code> - the site descriptor</dd> |
| <dd><code>logger</code> - logger of the class containing the injection site</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted using <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#interrupt--" title="class or interface in java.lang"><code>Thread.interrupt()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLatch-org.apache.drill.exec.testing.ExecutionControls-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getLatch</h4> |
| <pre><a href="../../../../../org/apache/drill/exec/testing/CountDownLatchInjection.html" title="interface in org.apache.drill.exec.testing">CountDownLatchInjection</a> getLatch(<a href="../../../../../org/apache/drill/exec/testing/ExecutionControls.html" title="class in org.apache.drill.exec.testing">ExecutionControls</a> executionControls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc)</pre> |
| <div class="block">Used to insert a latch in site class. See <a href="../../../../../org/apache/drill/exec/testing/CountDownLatchInjection.html" title="interface in org.apache.drill.exec.testing"><code>CountDownLatchInjection</code></a> and |
| <code>org.apache.drill.exec.testing.TestCountDownLatchInjection</code> for usage.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executionControls</code> - the controls in the current context</dd> |
| <dd><code>desc</code> - the site descriptor</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ControlsInjector.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/drill/exec/testing/ControlsInjectorFactory.html" title="class in org.apache.drill.exec.testing"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/drill/exec/testing/ControlsInjector.html" target="_top">Frames</a></li> |
| <li><a href="ControlsInjector.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |