/usr/share/doc/libosgi-core-java/api/org/osgi/framework/ServiceReference.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 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 | <!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_79) on Thu May 07 04:50:34 UTC 2015 -->
<title>ServiceReference</title>
<meta name="date" content="2015-05-07">
<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="ServiceReference";
}
//-->
</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/ServicePermission.html" title="class in org.osgi.framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/osgi/framework/ServiceRegistration.html" title="interface in org.osgi.framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/osgi/framework/ServiceReference.html" target="_top">Frames</a></li>
<li><a href="ServiceReference.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 ServiceReference" class="title">Interface ServiceReference<S></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - Type of Service.</dd></dl>
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.lang.Comparable<java.lang.Object></dd>
</dl>
<hr>
<br>
<pre>@ProviderType
public interface <span class="strong">ServiceReference<S></span>
extends java.lang.Comparable<java.lang.Object></pre>
<div class="block">A reference to a service.
<p>
The Framework returns <code>ServiceReference</code> objects from the
<code>BundleContext.getServiceReference</code> and
<code>BundleContext.getServiceReferences</code> methods.
<p>
A <code>ServiceReference</code> object may be shared between bundles and can be
used to examine the properties of the service and to get the service object.
<p>
Every service registered in the Framework has a unique
<code>ServiceRegistration</code> object and may have multiple, distinct
<code>ServiceReference</code> objects referring to it. <code>ServiceReference</code>
objects associated with a <code>ServiceRegistration</code> object have the same
<code>hashCode</code> and are considered equal (more specifically, their
<code>equals()</code> method will return <code>true</code> when compared).
<p>
If the same service object is registered multiple times,
<code>ServiceReference</code> objects associated with different
<code>ServiceRegistration</code> objects are not equal.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/osgi/framework/BundleContext.html#getServiceReference(java.lang.Class)"><code>BundleContext.getServiceReference(Class)</code></a>,
<a href="../../../org/osgi/framework/BundleContext.html#getServiceReference(java.lang.String)"><code>BundleContext.getServiceReference(String)</code></a>,
<a href="../../../org/osgi/framework/BundleContext.html#getServiceReferences(java.lang.Class,%20java.lang.String)"><code>BundleContext.getServiceReferences(Class, String)</code></a>,
<a href="../../../org/osgi/framework/BundleContext.html#getServiceReferences(java.lang.String,%20java.lang.String)"><code>BundleContext.getServiceReferences(String, String)</code></a>,
<a href="../../../org/osgi/framework/BundleContext.html#getService(org.osgi.framework.ServiceReference)"><code>BundleContext.getService(ServiceReference)</code></a>,
<a href="../../../org/osgi/framework/BundleContext.html#getServiceObjects(org.osgi.framework.ServiceReference)"><code>BundleContext.getServiceObjects(ServiceReference)</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>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/ServiceReference.html#compareTo(java.lang.Object)">compareTo</a></strong>(java.lang.Object reference)</code>
<div class="block">Compares this <code>ServiceReference</code> with the specified
<code>ServiceReference</code> for order.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/ServiceReference.html#getBundle()">getBundle</a></strong>()</code>
<div class="block">Returns the bundle that registered the service referenced by this
<code>ServiceReference</code> object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/ServiceReference.html#getProperty(java.lang.String)">getProperty</a></strong>(java.lang.String key)</code>
<div class="block">Returns the property value to which the specified property key is mapped
in the properties <code>Dictionary</code> object of the service referenced by
this <code>ServiceReference</code> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/ServiceReference.html#getPropertyKeys()">getPropertyKeys</a></strong>()</code>
<div class="block">Returns an array of the keys in the properties <code>Dictionary</code> object
of the service referenced by this <code>ServiceReference</code> object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/ServiceReference.html#getUsingBundles()">getUsingBundles</a></strong>()</code>
<div class="block">Returns the bundles that are using the service referenced by this
<code>ServiceReference</code> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/ServiceReference.html#isAssignableTo(org.osgi.framework.Bundle,%20java.lang.String)">isAssignableTo</a></strong>(<a href="../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a> bundle,
java.lang.String className)</code>
<div class="block">Tests if the bundle that registered the service referenced by this
<code>ServiceReference</code> and the specified bundle use the same source for
the package of the specified class name.</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="getProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre>java.lang.Object getProperty(java.lang.String key)</pre>
<div class="block">Returns the property value to which the specified property key is mapped
in the properties <code>Dictionary</code> object of the service referenced by
this <code>ServiceReference</code> object.
<p>
Property keys are case-insensitive.
<p>
This method must continue to return property values after the service has
been unregistered. This is so references to unregistered services (for
example, <code>ServiceReference</code> objects stored in the log) can still be
interrogated.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The property key.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The property value to which the key is mapped; <code>null</code> if
there is no property named after the key.</dd></dl>
</li>
</ul>
<a name="getPropertyKeys()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertyKeys</h4>
<pre>java.lang.String[] getPropertyKeys()</pre>
<div class="block">Returns an array of the keys in the properties <code>Dictionary</code> object
of the service referenced by this <code>ServiceReference</code> object.
<p>
This method will continue to return the keys after the service has been
unregistered. This is so references to unregistered services (for
example, <code>ServiceReference</code> objects stored in the log) can still be
interrogated.
<p>
This method is <i>case-preserving </i>; this means that every key in the
returned array must have the same case as the corresponding key in the
properties <code>Dictionary</code> that was passed to the
<a href="../../../org/osgi/framework/BundleContext.html#registerService(java.lang.String[],%20java.lang.Object,%20java.util.Dictionary)"><code>BundleContext.registerService(String[],Object,Dictionary)</code></a> or
<a href="../../../org/osgi/framework/ServiceRegistration.html#setProperties(java.util.Dictionary)"><code>ServiceRegistration.setProperties(Dictionary)</code></a> methods.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>An array of property keys.</dd></dl>
</li>
</ul>
<a name="getBundle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBundle</h4>
<pre><a href="../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a> getBundle()</pre>
<div class="block">Returns the bundle that registered the service referenced by this
<code>ServiceReference</code> object.
<p>
This method must return <code>null</code> when the service has been
unregistered. This can be used to determine if the service has been
unregistered.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The bundle that registered the service referenced by this
<code>ServiceReference</code> object; <code>null</code> if that service has
already been unregistered.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/osgi/framework/BundleContext.html#registerService(java.lang.String[],%20java.lang.Object,%20java.util.Dictionary)"><code>BundleContext.registerService(String[],Object,Dictionary)</code></a></dd></dl>
</li>
</ul>
<a name="getUsingBundles()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsingBundles</h4>
<pre><a href="../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a>[] getUsingBundles()</pre>
<div class="block">Returns the bundles that are using the service referenced by this
<code>ServiceReference</code> object. Specifically, this method returns the
bundles whose usage count for that service is greater than zero.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>An array of bundles whose usage count for the service referenced
by this <code>ServiceReference</code> object is greater than zero;
<code>null</code> if no bundles are currently using that service.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="isAssignableTo(org.osgi.framework.Bundle, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAssignableTo</h4>
<pre>boolean isAssignableTo(<a href="../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a> bundle,
java.lang.String className)</pre>
<div class="block">Tests if the bundle that registered the service referenced by this
<code>ServiceReference</code> and the specified bundle use the same source for
the package of the specified class name.
<p>
This method performs the following checks:
<ol>
<li>Get the package name from the specified class name.</li>
<li>For the bundle that registered the service referenced by this
<code>ServiceReference</code> (registrant bundle); find the source for the
package. If no source is found then return <code>true</code> if the registrant
bundle is equal to the specified bundle; otherwise return <code>false</code>.</li>
<li>If the package source of the registrant bundle is equal to the
package source of the specified bundle then return <code>true</code>;
otherwise return <code>false</code>.</li>
</ol></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bundle</code> - The <code>Bundle</code> object to check.</dd><dd><code>className</code> - The class name to check.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the bundle which registered the service
referenced by this <code>ServiceReference</code> and the specified
bundle use the same source for the package of the specified class
name. Otherwise <code>false</code> is returned.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If the specified <code>Bundle</code> was not
created by the same framework instance as this
<code>ServiceReference</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.3</dd></dl>
</li>
</ul>
<a name="compareTo(java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>compareTo</h4>
<pre>int compareTo(java.lang.Object reference)</pre>
<div class="block">Compares this <code>ServiceReference</code> with the specified
<code>ServiceReference</code> for order.
<p>
If this <code>ServiceReference</code> and the specified
<code>ServiceReference</code> have the same <a href="../../../org/osgi/framework/Constants.html#SERVICE_ID"><code>service id</code></a> they are equal. This <code>ServiceReference</code> is less than
the specified <code>ServiceReference</code> if it has a lower
<a href="../../../org/osgi/framework/Constants.html#SERVICE_RANKING"><code>service ranking</code></a> and greater if it has a
higher service ranking. Otherwise, if this <code>ServiceReference</code> and
the specified <code>ServiceReference</code> have the same
<a href="../../../org/osgi/framework/Constants.html#SERVICE_RANKING"><code>service ranking</code></a>, this
<code>ServiceReference</code> is less than the specified
<code>ServiceReference</code> if it has a higher <a href="../../../org/osgi/framework/Constants.html#SERVICE_ID"><code>service id</code></a> and greater if it has a lower service id.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>compareTo</code> in interface <code>java.lang.Comparable<java.lang.Object></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - The <code>ServiceReference</code> to be compared.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns a negative integer, zero, or a positive integer if this
<code>ServiceReference</code> is less than, equal to, or greater than
the specified <code>ServiceReference</code>.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If the specified
<code>ServiceReference</code> was not created by the same framework
instance as this <code>ServiceReference</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</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/ServicePermission.html" title="class in org.osgi.framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/osgi/framework/ServiceRegistration.html" title="interface in org.osgi.framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/osgi/framework/ServiceReference.html" target="_top">Frames</a></li>
<li><a href="ServiceReference.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>
|