/usr/share/doc/libhamcrest-java/api/org/hamcrest/core/Is.html is in libhamcrest-java-doc 1.3-5ubuntu1.
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 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 | <!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 (version 1.7.0_55) on Mon May 19 11:02:41 UTC 2014 -->
<title>Is (Hamcrest)</title>
<meta name="date" content="2014-05-19">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Is (Hamcrest)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/Is.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><a href="../../../org/hamcrest/core/Every.html" title="class in org.hamcrest.core"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/hamcrest/core/IsAnything.html" title="class in org.hamcrest.core"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/hamcrest/core/Is.html" target="_top">Frames</a></li>
<li><a href="Is.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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.hamcrest.core</div>
<h2 title="Class Is" class="title">Class Is<T></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../org/hamcrest/BaseMatcher.html" title="class in org.hamcrest">org.hamcrest.BaseMatcher</a><T></li>
<li>
<ul class="inheritance">
<li>org.hamcrest.core.Is<T></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><T>, <a href="../../../org/hamcrest/SelfDescribing.html" title="interface in org.hamcrest">SelfDescribing</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Is<T></span>
extends <a href="../../../org/hamcrest/BaseMatcher.html" title="class in org.hamcrest">BaseMatcher</a><T></pre>
<div class="block">Decorates another Matcher, retaining the behaviour but allowing tests
to be slightly more expressive.
For example: assertThat(cheese, equalTo(smelly))
vs. assertThat(cheese, is(equalTo(smelly)))</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/hamcrest/core/Is.html#Is(org.hamcrest.Matcher)">Is</a></strong>(<a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><<a href="../../../org/hamcrest/core/Is.html" title="type parameter in Is">T</a>> matcher)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hamcrest/core/Is.html#describeMismatch(java.lang.Object, org.hamcrest.Description)">describeMismatch</a></strong>(java.lang.Object item,
<a href="../../../org/hamcrest/Description.html" title="interface in org.hamcrest">Description</a> mismatchDescription)</code>
<div class="block">Generate a description of why the matcher has not accepted the item.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hamcrest/core/Is.html#describeTo(org.hamcrest.Description)">describeTo</a></strong>(<a href="../../../org/hamcrest/Description.html" title="interface in org.hamcrest">Description</a> description)</code>
<div class="block">Generates a description of the object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <T> <a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><T></code></td>
<td class="colLast"><code><strong><a href="../../../org/hamcrest/core/Is.html#is(java.lang.Class)">is</a></strong>(java.lang.Class<T> type)</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>use isA(Class<T> type) instead.</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <T> <a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><T></code></td>
<td class="colLast"><code><strong><a href="../../../org/hamcrest/core/Is.html#is(org.hamcrest.Matcher)">is</a></strong>(<a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><T> matcher)</code>
<div class="block">Decorates another Matcher, retaining its behaviour, but allowing tests
to be slightly more expressive.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <T> <a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><T></code></td>
<td class="colLast"><code><strong><a href="../../../org/hamcrest/core/Is.html#is(T)">is</a></strong>(T value)</code>
<div class="block">A shortcut to the frequently used <code>is(equalTo(x))</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <T> <a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><T></code></td>
<td class="colLast"><code><strong><a href="../../../org/hamcrest/core/Is.html#isA(java.lang.Class)">isA</a></strong>(java.lang.Class<T> type)</code>
<div class="block">A shortcut to the frequently used <code>is(instanceOf(SomeClass.class))</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/hamcrest/core/Is.html#matches(java.lang.Object)">matches</a></strong>(java.lang.Object arg)</code>
<div class="block">Evaluates the matcher for argument <var>item</var>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.hamcrest.BaseMatcher">
<!-- -->
</a>
<h3>Methods inherited from class org.hamcrest.<a href="../../../org/hamcrest/BaseMatcher.html" title="class in org.hamcrest">BaseMatcher</a></h3>
<code><a href="../../../org/hamcrest/BaseMatcher.html#_dont_implement_Matcher___instead_extend_BaseMatcher_()">_dont_implement_Matcher___instead_extend_BaseMatcher_</a>, <a href="../../../org/hamcrest/BaseMatcher.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Is(org.hamcrest.Matcher)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Is</h4>
<pre>public Is(<a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><<a href="../../../org/hamcrest/core/Is.html" title="type parameter in Is">T</a>> matcher)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="matches(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>matches</h4>
<pre>public boolean matches(java.lang.Object arg)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../org/hamcrest/Matcher.html#matches(java.lang.Object)">Matcher</a></code></strong></div>
<div class="block">Evaluates the matcher for argument <var>item</var>.
<p/>
This method matches against Object, instead of the generic type T. This is
because the caller of the Matcher does not know at runtime what the type is
(because of type erasure with Java generics). It is down to the implementations
to check the correct type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>arg</code> - the object against which the matcher is evaluated.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if <var>item</var> matches, otherwise <code>false</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/hamcrest/BaseMatcher.html" title="class in org.hamcrest"><code>BaseMatcher</code></a></dd></dl>
</li>
</ul>
<a name="describeTo(org.hamcrest.Description)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>describeTo</h4>
<pre>public void describeTo(<a href="../../../org/hamcrest/Description.html" title="interface in org.hamcrest">Description</a> description)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../org/hamcrest/SelfDescribing.html#describeTo(org.hamcrest.Description)">SelfDescribing</a></code></strong></div>
<div class="block">Generates a description of the object. The description may be part of a
a description of a larger object of which this is just a component, so it
should be worded appropriately.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>description</code> - The description to be built or appended to.</dd></dl>
</li>
</ul>
<a name="describeMismatch(java.lang.Object, org.hamcrest.Description)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>describeMismatch</h4>
<pre>public void describeMismatch(java.lang.Object item,
<a href="../../../org/hamcrest/Description.html" title="interface in org.hamcrest">Description</a> mismatchDescription)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../org/hamcrest/Matcher.html#describeMismatch(java.lang.Object, org.hamcrest.Description)">Matcher</a></code></strong></div>
<div class="block">Generate a description of why the matcher has not accepted the item.
The description will be part of a larger description of why a matching
failed, so it should be concise.
This method assumes that <code>matches(item)</code> is false, but
will not check this.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/hamcrest/Matcher.html#describeMismatch(java.lang.Object, org.hamcrest.Description)">describeMismatch</a></code> in interface <code><a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><<a href="../../../org/hamcrest/core/Is.html" title="type parameter in Is">T</a>></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../org/hamcrest/BaseMatcher.html#describeMismatch(java.lang.Object, org.hamcrest.Description)">describeMismatch</a></code> in class <code><a href="../../../org/hamcrest/BaseMatcher.html" title="class in org.hamcrest">BaseMatcher</a><<a href="../../../org/hamcrest/core/Is.html" title="type parameter in Is">T</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>item</code> - The item that the Matcher has rejected.</dd><dd><code>mismatchDescription</code> - The description to be built or appended to.</dd></dl>
</li>
</ul>
<a name="is(org.hamcrest.Matcher)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>is</h4>
<pre>public static <T> <a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><T> is(<a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><T> matcher)</pre>
<div class="block">Decorates another Matcher, retaining its behaviour, but allowing tests
to be slightly more expressive.
<p/>
For example:
<pre>assertThat(cheese, is(equalTo(smelly)))</pre>
instead of:
<pre>assertThat(cheese, equalTo(smelly))</pre></div>
</li>
</ul>
<a name="is(java.lang.Object)">
<!-- -->
</a><a name="is(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>is</h4>
<pre>public static <T> <a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><T> is(T value)</pre>
<div class="block">A shortcut to the frequently used <code>is(equalTo(x))</code>.
<p/>
For example:
<pre>assertThat(cheese, is(smelly))</pre>
instead of:
<pre>assertThat(cheese, is(equalTo(smelly)))</pre></div>
</li>
</ul>
<a name="is(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>is</h4>
<pre>@Deprecated
public static <T> <a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><T> is(java.lang.Class<T> type)</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>use isA(Class<T> type) instead.</i></div>
<div class="block">A shortcut to the frequently used <code>is(instanceOf(SomeClass.class))</code>.
<p/>
For example:
<pre>assertThat(cheese, is(Cheddar.class))</pre>
instead of:
<pre>assertThat(cheese, is(instanceOf(Cheddar.class)))</pre></div>
</li>
</ul>
<a name="isA(java.lang.Class)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isA</h4>
<pre>public static <T> <a href="../../../org/hamcrest/Matcher.html" title="interface in org.hamcrest">Matcher</a><T> isA(java.lang.Class<T> type)</pre>
<div class="block">A shortcut to the frequently used <code>is(instanceOf(SomeClass.class))</code>.
<p/>
For example:
<pre>assertThat(cheese, isA(Cheddar.class))</pre>
instead of:
<pre>assertThat(cheese, is(instanceOf(Cheddar.class)))</pre></div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Is.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><a href="../../../org/hamcrest/core/Every.html" title="class in org.hamcrest.core"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/hamcrest/core/IsAnything.html" title="class in org.hamcrest.core"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/hamcrest/core/Is.html" target="_top">Frames</a></li>
<li><a href="Is.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|