/usr/share/doc/junit4/api/org/junit/ClassRule.html is in junit4-doc 4.12-6.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClassRule (JUnit API)</title>
<meta name="keywords" content="org.junit.ClassRule class">
<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="ClassRule (JUnit API)";
}
}
catch(err) {
}
//-->
</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/BeforeClass.html" title="annotation in org.junit"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../org/junit/ComparisonFailure.html" title="class in org.junit"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/junit/ClassRule.html" target="_top">Frames</a></li>
<li><a href="ClassRule.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>Field | </li>
<li>Required | </li>
<li>Optional</li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Element</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</div>
<h2 title="Annotation Type ClassRule" class="title">Annotation Type ClassRule</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>})
public @interface <a href="../../src-html/org/junit/ClassRule.html#line.86">ClassRule</a></pre>
<div class="block">Annotates static fields that reference rules or methods that return them. A field must be public,
static, and a subtype of <a href="../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a>. A method must be public static, and return
a subtype of <a href="../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a>.
<p>
The <a href="../../org/junit/runners/model/Statement.html" title="class in org.junit.runners.model"><code>Statement</code></a> passed
to the <a href="../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a> will run any <a href="../../org/junit/BeforeClass.html" title="annotation in org.junit"><code>BeforeClass</code></a> methods,
then the entire body of the test class (all contained methods, if it is
a standard JUnit test class, or all contained classes, if it is a
<a href="../../org/junit/runners/Suite.html" title="class in org.junit.runners"><code>Suite</code></a>), and finally any <a href="../../org/junit/AfterClass.html" title="annotation in org.junit"><code>AfterClass</code></a> methods.
<p>
The statement passed to the <a href="../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a> will never throw an exception,
and throwing an exception from the <a href="../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a> will result in undefined
behavior. This means that some <a href="../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a>s, such as
<a href="../../org/junit/rules/ErrorCollector.html" title="class in org.junit.rules"><code>ErrorCollector</code></a>,
<a href="../../org/junit/rules/ExpectedException.html" title="class in org.junit.rules"><code>ExpectedException</code></a>,
and <a href="../../org/junit/rules/Timeout.html" title="class in org.junit.rules"><code>Timeout</code></a>,
have undefined behavior when used as <a href="../../org/junit/ClassRule.html" title="annotation in org.junit"><code>ClassRule</code></a>s.
<p>
If there are multiple
annotated <a href="../../org/junit/ClassRule.html" title="annotation in org.junit"><code>ClassRule</code></a>s on a class, they will be applied in an order
that depends on your JVM's implementation of the reflection API, which is
undefined, in general. However, Rules defined by fields will always be applied
before Rules defined by methods.
<p>
For example, here is a test suite that connects to a server once before
all the test classes run, and disconnects after they are finished:
<pre>
@RunWith(Suite.class)
@SuiteClasses({A.class, B.class, C.class})
public class UsesExternalResource {
public static Server myServer= new Server();
@ClassRule
public static ExternalResource resource= new ExternalResource() {
@Override
protected void before() throws Throwable {
myServer.connect();
}
@Override
protected void after() {
myServer.disconnect();
}
};
}
</pre>
<p>
and the same using a method
<pre>
@RunWith(Suite.class)
@SuiteClasses({A.class, B.class, C.class})
public class UsesExternalResource {
public static Server myServer= new Server();
@ClassRule
public static ExternalResource getResource() {
return new ExternalResource() {
@Override
protected void before() throws Throwable {
myServer.connect();
}
@Override
protected void after() {
myServer.disconnect();
}
};
}
}
</pre>
<p>
For more information and more examples, see <a href="../../org/junit/rules/TestRule.html" title="interface in org.junit.rules"><code>TestRule</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.9</dd>
</dl>
</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/BeforeClass.html" title="annotation in org.junit"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../org/junit/ComparisonFailure.html" title="class in org.junit"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/junit/ClassRule.html" target="_top">Frames</a></li>
<li><a href="ClassRule.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>Field | </li>
<li>Required | </li>
<li>Optional</li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Element</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2002–2017 <a href="http://www.junit.org">JUnit</a>. All rights reserved.</small></p>
</body>
</html>
|