/usr/share/doc/libhamcrest-java/api/org/hamcrest/Matcher.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 | <!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>Matcher (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="Matcher (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/Matcher.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/FeatureMatcher.html" title="class in org.hamcrest"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/hamcrest/MatcherAssert.html" title="class in org.hamcrest"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/hamcrest/Matcher.html" target="_top">Frames</a></li>
<li><a href="Matcher.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.hamcrest</div>
<h2 title="Interface Matcher" class="title">Interface Matcher<T></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../org/hamcrest/SelfDescribing.html" title="interface in org.hamcrest">SelfDescribing</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../org/hamcrest/core/AllOf.html" title="class in org.hamcrest.core">AllOf</a>, <a href="../../org/hamcrest/core/AnyOf.html" title="class in org.hamcrest.core">AnyOf</a>, <a href="../../org/hamcrest/BaseMatcher.html" title="class in org.hamcrest">BaseMatcher</a>, <a href="../../org/hamcrest/number/BigDecimalCloseTo.html" title="class in org.hamcrest.number">BigDecimalCloseTo</a>, <a href="../../org/hamcrest/core/CombinableMatcher.html" title="class in org.hamcrest.core">CombinableMatcher</a>, <a href="../../org/hamcrest/CustomMatcher.html" title="class in org.hamcrest">CustomMatcher</a>, <a href="../../org/hamcrest/CustomTypeSafeMatcher.html" title="class in org.hamcrest">CustomTypeSafeMatcher</a>, <a href="../../org/hamcrest/core/DescribedAs.html" title="class in org.hamcrest.core">DescribedAs</a>, <a href="../../org/hamcrest/DiagnosingMatcher.html" title="class in org.hamcrest">DiagnosingMatcher</a>, <a href="../../org/hamcrest/core/Every.html" title="class in org.hamcrest.core">Every</a>, <a href="../../org/hamcrest/FeatureMatcher.html" title="class in org.hamcrest">FeatureMatcher</a>, <a href="../../org/hamcrest/beans/HasProperty.html" title="class in org.hamcrest.beans">HasProperty</a>, <a href="../../org/hamcrest/beans/HasPropertyWithValue.html" title="class in org.hamcrest.beans">HasPropertyWithValue</a>, <a href="../../org/hamcrest/object/HasToString.html" title="class in org.hamcrest.object">HasToString</a>, <a href="../../org/hamcrest/xml/HasXPath.html" title="class in org.hamcrest.xml">HasXPath</a>, <a href="../../org/hamcrest/core/Is.html" title="class in org.hamcrest.core">Is</a>, <a href="../../org/hamcrest/core/IsAnything.html" title="class in org.hamcrest.core">IsAnything</a>, <a href="../../org/hamcrest/collection/IsArray.html" title="class in org.hamcrest.collection">IsArray</a>, <a href="../../org/hamcrest/collection/IsArrayContaining.html" title="class in org.hamcrest.collection">IsArrayContaining</a>, <a href="../../org/hamcrest/collection/IsArrayContainingInAnyOrder.html" title="class in org.hamcrest.collection">IsArrayContainingInAnyOrder</a>, <a href="../../org/hamcrest/collection/IsArrayContainingInOrder.html" title="class in org.hamcrest.collection">IsArrayContainingInOrder</a>, <a href="../../org/hamcrest/collection/IsArrayWithSize.html" title="class in org.hamcrest.collection">IsArrayWithSize</a>, <a href="../../org/hamcrest/number/IsCloseTo.html" title="class in org.hamcrest.number">IsCloseTo</a>, <a href="../../org/hamcrest/core/IsCollectionContaining.html" title="class in org.hamcrest.core">IsCollectionContaining</a>, <a href="../../org/hamcrest/collection/IsCollectionWithSize.html" title="class in org.hamcrest.collection">IsCollectionWithSize</a>, <a href="../../org/hamcrest/object/IsCompatibleType.html" title="class in org.hamcrest.object">IsCompatibleType</a>, <a href="../../org/hamcrest/collection/IsEmptyCollection.html" title="class in org.hamcrest.collection">IsEmptyCollection</a>, <a href="../../org/hamcrest/collection/IsEmptyIterable.html" title="class in org.hamcrest.collection">IsEmptyIterable</a>, <a href="../../org/hamcrest/text/IsEmptyString.html" title="class in org.hamcrest.text">IsEmptyString</a>, <a href="../../org/hamcrest/core/IsEqual.html" title="class in org.hamcrest.core">IsEqual</a>, <a href="../../org/hamcrest/text/IsEqualIgnoringCase.html" title="class in org.hamcrest.text">IsEqualIgnoringCase</a>, <a href="../../org/hamcrest/text/IsEqualIgnoringWhiteSpace.html" title="class in org.hamcrest.text">IsEqualIgnoringWhiteSpace</a>, <a href="../../org/hamcrest/object/IsEventFrom.html" title="class in org.hamcrest.object">IsEventFrom</a>, <a href="../../org/hamcrest/collection/IsIn.html" title="class in org.hamcrest.collection">IsIn</a>, <a href="../../org/hamcrest/core/IsInstanceOf.html" title="class in org.hamcrest.core">IsInstanceOf</a>, <a href="../../org/hamcrest/collection/IsIterableContainingInAnyOrder.html" title="class in org.hamcrest.collection">IsIterableContainingInAnyOrder</a>, <a href="../../org/hamcrest/collection/IsIterableContainingInOrder.html" title="class in org.hamcrest.collection">IsIterableContainingInOrder</a>, <a href="../../org/hamcrest/collection/IsIterableWithSize.html" title="class in org.hamcrest.collection">IsIterableWithSize</a>, <a href="../../org/hamcrest/collection/IsMapContaining.html" title="class in org.hamcrest.collection">IsMapContaining</a>, <a href="../../org/hamcrest/core/IsNot.html" title="class in org.hamcrest.core">IsNot</a>, <a href="../../org/hamcrest/core/IsNull.html" title="class in org.hamcrest.core">IsNull</a>, <a href="../../org/hamcrest/core/IsSame.html" title="class in org.hamcrest.core">IsSame</a>, <a href="../../org/hamcrest/number/OrderingComparison.html" title="class in org.hamcrest.number">OrderingComparison</a>, <a href="../../org/hamcrest/beans/SamePropertyValuesAs.html" title="class in org.hamcrest.beans">SamePropertyValuesAs</a>, <a href="../../org/hamcrest/beans/SamePropertyValuesAs.PropertyMatcher.html" title="class in org.hamcrest.beans">SamePropertyValuesAs.PropertyMatcher</a>, <a href="../../org/hamcrest/core/StringContains.html" title="class in org.hamcrest.core">StringContains</a>, <a href="../../org/hamcrest/text/StringContainsInOrder.html" title="class in org.hamcrest.text">StringContainsInOrder</a>, <a href="../../org/hamcrest/core/StringEndsWith.html" title="class in org.hamcrest.core">StringEndsWith</a>, <a href="../../org/hamcrest/core/StringStartsWith.html" title="class in org.hamcrest.core">StringStartsWith</a>, <a href="../../org/hamcrest/core/SubstringMatcher.html" title="class in org.hamcrest.core">SubstringMatcher</a>, <a href="../../org/hamcrest/TypeSafeDiagnosingMatcher.html" title="class in org.hamcrest">TypeSafeDiagnosingMatcher</a>, <a href="../../org/hamcrest/TypeSafeMatcher.html" title="class in org.hamcrest">TypeSafeMatcher</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Matcher<T></span>
extends <a href="../../org/hamcrest/SelfDescribing.html" title="interface in org.hamcrest">SelfDescribing</a></pre>
<div class="block">A matcher over acceptable values.
A matcher is able to describe itself to give feedback when it fails.
<p/>
Matcher implementations should <b>NOT directly implement this interface</b>.
Instead, <b>extend</b> the <a href="../../org/hamcrest/BaseMatcher.html" title="class in org.hamcrest"><code>BaseMatcher</code></a> abstract class,
which will ensure that the Matcher API can grow to support
new features and remain compatible with all Matcher implementations.
<p/>
For easy access to common Matcher implementations, use the static factory
methods in <a href="../../org/hamcrest/CoreMatchers.html" title="class in org.hamcrest"><code>CoreMatchers</code></a>.
<p/>
N.B. Well designed matchers should be immutable.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../org/hamcrest/CoreMatchers.html" title="class in org.hamcrest"><code>CoreMatchers</code></a>,
<a href="../../org/hamcrest/BaseMatcher.html" title="class in org.hamcrest"><code>BaseMatcher</code></a></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="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/Matcher.html#_dont_implement_Matcher___instead_extend_BaseMatcher_()">_dont_implement_Matcher___instead_extend_BaseMatcher_</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>to make</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/hamcrest/Matcher.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="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/hamcrest/Matcher.html#matches(java.lang.Object)">matches</a></strong>(java.lang.Object item)</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.SelfDescribing">
<!-- -->
</a>
<h3>Methods inherited from interface org.hamcrest.<a href="../../org/hamcrest/SelfDescribing.html" title="interface in org.hamcrest">SelfDescribing</a></h3>
<code><a href="../../org/hamcrest/SelfDescribing.html#describeTo(org.hamcrest.Description)">describeTo</a></code></li>
</ul>
</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="matches(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>matches</h4>
<pre>boolean matches(java.lang.Object item)</pre>
<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>item</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="describeMismatch(java.lang.Object, org.hamcrest.Description)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>describeMismatch</h4>
<pre>void describeMismatch(java.lang.Object item,
<a href="../../org/hamcrest/Description.html" title="interface in org.hamcrest">Description</a> mismatchDescription)</pre>
<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><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="_dont_implement_Matcher___instead_extend_BaseMatcher_()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_dont_implement_Matcher___instead_extend_BaseMatcher_</h4>
<pre>@Deprecated
void _dont_implement_Matcher___instead_extend_BaseMatcher_()</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>to make</i></div>
<div class="block">This method simply acts a friendly reminder not to implement Matcher directly and
instead extend BaseMatcher. It's easy to ignore JavaDoc, but a bit harder to ignore
compile errors .</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../org/hamcrest/Matcher.html" title="interface in org.hamcrest"><code>for reasons why.</code></a>,
<a href="../../org/hamcrest/BaseMatcher.html" title="class in org.hamcrest"><code>BaseMatcher</code></a></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><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/Matcher.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/FeatureMatcher.html" title="class in org.hamcrest"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/hamcrest/MatcherAssert.html" title="class in org.hamcrest"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/hamcrest/Matcher.html" target="_top">Frames</a></li>
<li><a href="Matcher.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>
|