/usr/share/doc/libosgi-core-java/api/org/osgi/framework/Filter.html is in libosgi-core-java-doc 6.0.0-1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Filter</title>
<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="Filter";
}
//-->
</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="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/osgi/framework/Constants.html" title="interface in org.osgi.framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/osgi/framework/FrameworkEvent.html" title="class in org.osgi.framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/osgi/framework/Filter.html" target="_top">Frames</a></li>
<li><a href="Filter.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.osgi.framework</div>
<h2 title="Interface Filter" class="title">Interface Filter</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@ProviderType
public interface <span class="strong">Filter</span></pre>
<div class="block">An <a href="http://www.ietf.org/rfc/rfc1960.txt">RFC 1960</a>-based Filter.
<p>
<code>Filter</code>s can be created by calling
<a href="../../../org/osgi/framework/BundleContext.html#createFilter(java.lang.String)"><code>BundleContext.createFilter(String)</code></a> or
<a href="../../../org/osgi/framework/FrameworkUtil.html#createFilter(java.lang.String)"><code>FrameworkUtil.createFilter(String)</code></a> with a filter string.
<p>
A <code>Filter</code> can be used numerous times to determine if the match
argument matches the filter string that was used to create the <code>Filter</code>.
<p>
Some examples of LDAP filters are:
<pre>
"(cn=Babs Jensen)"
"(!(cn=Tim Howes))"
"(&(" + Constants.OBJECTCLASS + "=Person)(|(sn=Jensen)(cn=Babs J*)))"
"(o=univ*of*mich*)"
</pre></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="strong">See Also:</span></dt><dd>"Core Specification, Filters, for a description of the filter string syntax."</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/Filter.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code>
<div class="block">Compares this <code>Filter</code> to another <code>Filter</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/Filter.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Returns the hashCode for this <code>Filter</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/Filter.html#match(java.util.Dictionary)">match</a></strong>(java.util.Dictionary<java.lang.String,?> dictionary)</code>
<div class="block">Filter using a <code>Dictionary</code> with case insensitive key lookup.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/Filter.html#match(org.osgi.framework.ServiceReference)">match</a></strong>(<a href="../../../org/osgi/framework/ServiceReference.html" title="interface in org.osgi.framework">ServiceReference</a><?> reference)</code>
<div class="block">Filter using a service's properties.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/Filter.html#matchCase(java.util.Dictionary)">matchCase</a></strong>(java.util.Dictionary<java.lang.String,?> dictionary)</code>
<div class="block">Filter using a <code>Dictionary</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/Filter.html#matches(java.util.Map)">matches</a></strong>(java.util.Map<java.lang.String,?> map)</code>
<div class="block">Filter using a <code>Map</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/Filter.html#toString()">toString</a></strong>()</code>
<div class="block">Returns this <code>Filter</code>'s filter string.</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="match(org.osgi.framework.ServiceReference)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>match</h4>
<pre>boolean match(<a href="../../../org/osgi/framework/ServiceReference.html" title="interface in org.osgi.framework">ServiceReference</a><?> reference)</pre>
<div class="block">Filter using a service's properties.
<p>
This <code>Filter</code> is executed using the keys and values of the
referenced service's properties. The keys are looked up in a case
insensitive manner.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - The reference to the service whose properties are used
in the match.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the service's properties match this
<code>Filter</code>; <code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="match(java.util.Dictionary)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>match</h4>
<pre>boolean match(java.util.Dictionary<java.lang.String,?> dictionary)</pre>
<div class="block">Filter using a <code>Dictionary</code> with case insensitive key lookup. This
<code>Filter</code> is executed using the specified <code>Dictionary</code>'s keys
and values. The keys are looked up in a case insensitive manner.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dictionary</code> - The <code>Dictionary</code> whose key/value pairs are used
in the match.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the <code>Dictionary</code>'s values match this
filter; <code>false</code> otherwise.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If <code>dictionary</code> contains case
variants of the same key name.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>java.lang.String toString()</pre>
<div class="block">Returns this <code>Filter</code>'s filter string.
<p>
The filter string is normalized by removing whitespace which does not
affect the meaning of the filter.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>This <code>Filter</code>'s filter string.</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>boolean equals(java.lang.Object obj)</pre>
<div class="block">Compares this <code>Filter</code> to another <code>Filter</code>.
<p>
This implementation returns the result of calling
<code>this.toString().equals(obj.toString())</code>.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - The object to compare against this <code>Filter</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>If the other object is a <code>Filter</code> object, then returns the
result of calling <code>this.toString().equals(obj.toString())</code>;
<code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>int hashCode()</pre>
<div class="block">Returns the hashCode for this <code>Filter</code>.
<p>
This implementation returns the result of calling
<code>this.toString().hashCode()</code>.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The hashCode of this <code>Filter</code>.</dd></dl>
</li>
</ul>
<a name="matchCase(java.util.Dictionary)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>matchCase</h4>
<pre>boolean matchCase(java.util.Dictionary<java.lang.String,?> dictionary)</pre>
<div class="block">Filter using a <code>Dictionary</code>. This <code>Filter</code> is executed using
the specified <code>Dictionary</code>'s keys and values. The keys are looked
up in a normal manner respecting case.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dictionary</code> - The <code>Dictionary</code> whose key/value pairs are used
in the match.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the <code>Dictionary</code>'s values match this
filter; <code>false</code> otherwise.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.3</dd></dl>
</li>
</ul>
<a name="matches(java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>matches</h4>
<pre>boolean matches(java.util.Map<java.lang.String,?> map)</pre>
<div class="block">Filter using a <code>Map</code>. This <code>Filter</code> is executed using the
specified <code>Map</code>'s keys and values. The keys are looked up in a
normal manner respecting case.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - The <code>Map</code> whose key/value pairs are used in the match.
Maps with <code>null</code> key or values are not supported. A
<code>null</code> value is considered not present to the filter.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the <code>Map</code>'s values match this filter;
<code>false</code> otherwise.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.6</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="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/osgi/framework/Constants.html" title="interface in org.osgi.framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/osgi/framework/FrameworkEvent.html" title="class in org.osgi.framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/osgi/framework/Filter.html" target="_top">Frames</a></li>
<li><a href="Filter.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>
|