/usr/share/doc/junit4/api/org/junit/rules/TestRule.html is in junit4-doc 4.12-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 | <!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 (1.8.0_01-internal) on Tue Mar 08 12:18:39 UTC 2016 -->
<title>TestRule (JUnit 4.12 API)</title>
<meta name="date" content="2016-03-08">
<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="TestRule (JUnit 4.12 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":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="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><a href="../../../org/junit/rules/TestName.html" title="class in org.junit.rules"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/junit/rules/TestWatcher.html" title="class in org.junit.rules"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/junit/rules/TestRule.html" target="_top">Frames</a></li>
<li><a href="TestRule.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.junit.rules</div>
<h2 title="Interface TestRule" class="title">Interface TestRule</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/junit/rules/DisableOnDebug.html" title="class in org.junit.rules">DisableOnDebug</a>, <a href="../../../org/junit/rules/ErrorCollector.html" title="class in org.junit.rules">ErrorCollector</a>, <a href="../../../org/junit/rules/ExpectedException.html" title="class in org.junit.rules">ExpectedException</a>, <a href="../../../org/junit/rules/ExternalResource.html" title="class in org.junit.rules">ExternalResource</a>, <a href="../../../org/junit/rules/RuleChain.html" title="class in org.junit.rules">RuleChain</a>, <a href="../../../org/junit/rules/Stopwatch.html" title="class in org.junit.rules">Stopwatch</a>, <a href="../../../org/junit/rules/TemporaryFolder.html" title="class in org.junit.rules">TemporaryFolder</a>, <a href="../../../org/junit/rules/TestName.html" title="class in org.junit.rules">TestName</a>, <a href="../../../org/junit/rules/TestWatcher.html" title="class in org.junit.rules">TestWatcher</a>, <a href="../../../org/junit/rules/Timeout.html" title="class in org.junit.rules">Timeout</a>, <a href="../../../org/junit/rules/Verifier.html" title="class in org.junit.rules">Verifier</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">TestRule</span></pre>
<div class="block">A TestRule is an alteration in how a test method, or set of test methods,
is run and reported. A <a href="../../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a> may add additional checks that cause
a test that would otherwise fail to pass, or it may perform necessary setup or
cleanup for tests, or it may observe test execution to report it elsewhere.
<a href="../../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a>s can do everything that could be done previously with
methods annotated with <a href="../../../org/junit/Before.html" title="annotation in org.junit"><code>Before</code></a>,
<a href="../../../org/junit/After.html" title="annotation in org.junit"><code>After</code></a>, <a href="../../../org/junit/BeforeClass.html" title="annotation in org.junit"><code>BeforeClass</code></a>, or
<a href="../../../org/junit/AfterClass.html" title="annotation in org.junit"><code>AfterClass</code></a>, but they are more powerful, and more easily
shared
between projects and classes.
The default JUnit test runners for suites and
individual test cases recognize <a href="../../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a>s introduced in two different
ways. <a href="../../../org/junit/Rule.html" title="annotation in org.junit"><code>Rule</code></a> annotates method-level
<a href="../../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a>s, and <a href="../../../org/junit/ClassRule.html" title="annotation in org.junit"><code>ClassRule</code></a>
annotates class-level <a href="../../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a>s. See Javadoc for those annotations
for more information.
Multiple <a href="../../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a>s can be applied to a test or suite execution. The
<a href="../../../org/junit/runners/model/Statement.html" title="class in org.junit.runners.model"><code>Statement</code></a> that executes the method or suite is passed to each annotated
<a href="../../../org/junit/Rule.html" title="annotation in org.junit"><code>Rule</code></a> in turn, and each may return a substitute or modified
<a href="../../../org/junit/runners/model/Statement.html" title="class in org.junit.runners.model"><code>Statement</code></a>, which is passed to the next <a href="../../../org/junit/Rule.html" title="annotation in org.junit"><code>Rule</code></a>, if any. For
examples of how this can be useful, see these provided TestRules,
or write your own:
<ul>
<li><a href="../../../org/junit/rules/ErrorCollector.html" title="class in org.junit.rules"><code>ErrorCollector</code></a>: collect multiple errors in one test method</li>
<li><a href="../../../org/junit/rules/ExpectedException.html" title="class in org.junit.rules"><code>ExpectedException</code></a>: make flexible assertions about thrown exceptions</li>
<li><a href="../../../org/junit/rules/ExternalResource.html" title="class in org.junit.rules"><code>ExternalResource</code></a>: start and stop a server, for example</li>
<li><a href="../../../org/junit/rules/TemporaryFolder.html" title="class in org.junit.rules"><code>TemporaryFolder</code></a>: create fresh files, and delete after test</li>
<li><a href="../../../org/junit/rules/TestName.html" title="class in org.junit.rules"><code>TestName</code></a>: remember the test name for use during the method</li>
<li><a href="../../../org/junit/rules/TestWatcher.html" title="class in org.junit.rules"><code>TestWatcher</code></a>: add logic at events during method execution</li>
<li><a href="../../../org/junit/rules/Timeout.html" title="class in org.junit.rules"><code>Timeout</code></a>: cause test to fail after a set time</li>
<li><a href="../../../org/junit/rules/Verifier.html" title="class in org.junit.rules"><code>Verifier</code></a>: fail test if object state ends up incorrect</li>
</ul></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.9</dd>
</dl>
</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/junit/runners/model/Statement.html" title="class in org.junit.runners.model">Statement</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/junit/rules/TestRule.html#apply-org.junit.runners.model.Statement-org.junit.runner.Description-">apply</a></span>(<a href="../../../org/junit/runners/model/Statement.html" title="class in org.junit.runners.model">Statement</a> base,
<a href="../../../org/junit/runner/Description.html" title="class in org.junit.runner">Description</a> description)</code>
<div class="block">Modifies the method-running <a href="../../../org/junit/runners/model/Statement.html" title="class in org.junit.runners.model"><code>Statement</code></a> to implement this
test-running rule.</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="apply-org.junit.runners.model.Statement-org.junit.runner.Description-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>apply</h4>
<pre><a href="../../../org/junit/runners/model/Statement.html" title="class in org.junit.runners.model">Statement</a> apply(<a href="../../../org/junit/runners/model/Statement.html" title="class in org.junit.runners.model">Statement</a> base,
<a href="../../../org/junit/runner/Description.html" title="class in org.junit.runner">Description</a> description)</pre>
<div class="block">Modifies the method-running <a href="../../../org/junit/runners/model/Statement.html" title="class in org.junit.runners.model"><code>Statement</code></a> to implement this
test-running rule.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>base</code> - The <a href="../../../org/junit/runners/model/Statement.html" title="class in org.junit.runners.model"><code>Statement</code></a> to be modified</dd>
<dd><code>description</code> - A <a href="../../../org/junit/runner/Description.html" title="class in org.junit.runner"><code>Description</code></a> of the test implemented in <code>base</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new statement, which may be the same as <code>base</code>,
a wrapper around <code>base</code>, or a completely new Statement.</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="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><a href="../../../org/junit/rules/TestName.html" title="class in org.junit.rules"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/junit/rules/TestWatcher.html" title="class in org.junit.rules"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/junit/rules/TestRule.html" target="_top">Frames</a></li>
<li><a href="TestRule.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 ======= -->
</body>
</html>
|