/usr/share/doc/junit4/api/org/junit/Test.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 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 | <!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>Test (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="Test (JUnit 4.12 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/Rule.html" title="annotation in org.junit"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../org/junit/Test.None.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/Test.html" target="_top">Frames</a></li>
<li><a href="Test.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><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#annotation.type.element.detail">Element</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</div>
<h2 title="Annotation Type Test" class="title">Annotation Type Test</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="/usr/share/doc/default-jre/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="/usr/share/doc/default-jre/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="/usr/share/doc/default-jre/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="/usr/share/doc/default-jre/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="/usr/share/doc/default-jre/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="/usr/share/doc/default-jre/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>)
public @interface <span class="memberNameLabel">Test</span></pre>
<div class="block">The <code>Test</code> annotation tells JUnit that the <code>public void</code> method
to which it is attached can be run as a test case. To run the method,
JUnit first constructs a fresh instance of the class then invokes the
annotated method. Any exceptions thrown by the test will be reported
by JUnit as a failure. If no exceptions are thrown, the test is assumed
to have succeeded.
<p>
A simple test looks like this:
<pre>
public class Example {
<b>@Test</b>
public void method() {
org.junit.Assert.assertTrue( new ArrayList().isEmpty() );
}
}
</pre>
<p>
The <code>Test</code> annotation supports two optional parameters.
The first, <code>expected</code>, declares that a test method should throw
an exception. If it doesn't throw an exception or if it throws a different exception
than the one declared, the test fails. For example, the following test succeeds:
<pre>
@Test(<b>expected=IndexOutOfBoundsException.class</b>) public void outOfBounds() {
new ArrayList<Object>().get(1);
}
</pre>
If the exception's message or one of its properties should be verified, the
<a href="../../org/junit/rules/ExpectedException.html" title="class in org.junit.rules"><code>ExpectedException</code></a> rule can be used. Further
information about exception testing can be found at the
<a href="https://github.com/junit-team/junit/wiki/Exception-testing">JUnit Wiki</a>.
<p>
The second optional parameter, <code>timeout</code>, causes a test to fail if it takes
longer than a specified amount of clock time (measured in milliseconds). The following test fails:
<pre>
@Test(<b>timeout=100</b>) public void infinity() {
while(true);
}
</pre>
<b>Warning</b>: while <code>timeout</code> is useful to catch and terminate
infinite loops, it should <em>not</em> be considered deterministic. The
following test may or may not fail depending on how the operating system
schedules threads:
<pre>
@Test(<b>timeout=100</b>) public void sleep100() {
Thread.sleep(100);
}
</pre>
<b>THREAD SAFETY WARNING:</b> Test methods with a timeout parameter are run in a thread other than the
thread which runs the fixture's @Before and @After methods. This may yield different behavior for
code that is not thread safe when compared to the same test method without a timeout parameter.
<b>Consider using the <a href="../../org/junit/rules/Timeout.html" title="class in org.junit.rules"><code>Timeout</code></a> rule instead</b>, which ensures a test method is run on the
same thread as the fixture's @Before and @After methods.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jre/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="/usr/share/doc/default-jre/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/junit/Test.html#expected--">expected</a></span></code>
<div class="block">Optionally specify <code>expected</code>, a Throwable, to cause a test method to succeed if
and only if an exception of the specified class is thrown by the method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/junit/Test.html#timeout--">timeout</a></span></code>
<div class="block">Optionally specify <code>timeout</code> in milliseconds to cause a test method to fail if it
takes longer than that number of milliseconds.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="expected--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>expected</h4>
<pre>public abstract <a href="/usr/share/doc/default-jre/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="/usr/share/doc/default-jre/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>> expected</pre>
<div class="block">Optionally specify <code>expected</code>, a Throwable, to cause a test method to succeed if
and only if an exception of the specified class is thrown by the method. If the Throwable's
message or one of its properties should be verified, the
<a href="../../org/junit/rules/ExpectedException.html" title="class in org.junit.rules"><code>ExpectedException</code></a> rule can be used instead.</div>
<dl>
<dt>Default:</dt>
<dd>org.junit.Test.None.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="timeout--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>timeout</h4>
<pre>public abstract long timeout</pre>
<div class="block">Optionally specify <code>timeout</code> in milliseconds to cause a test method to fail if it
takes longer than that number of milliseconds.
<p>
<b>THREAD SAFETY WARNING:</b> Test methods with a timeout parameter are run in a thread other than the
thread which runs the fixture's @Before and @After methods. This may yield different behavior for
code that is not thread safe when compared to the same test method without a timeout parameter.
<b>Consider using the <a href="../../org/junit/rules/Timeout.html" title="class in org.junit.rules"><code>Timeout</code></a> rule instead</b>, which ensures a test method is run on the
same thread as the fixture's @Before and @After methods.
</p></div>
<dl>
<dt>Default:</dt>
<dd>0L</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/Rule.html" title="annotation in org.junit"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../org/junit/Test.None.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/Test.html" target="_top">Frames</a></li>
<li><a href="Test.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><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|