/usr/share/doc/libosgi-core-java/api/org/osgi/resource/Wiring.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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Wiring</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="Wiring";
}
//-->
</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/resource/Wire.html" title="interface in org.osgi.resource"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/osgi/resource/Wiring.html" target="_top">Frames</a></li>
<li><a href="Wiring.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.resource</div>
<h2 title="Interface Wiring" class="title">Interface Wiring</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../org/osgi/framework/wiring/BundleWiring.html" title="interface in org.osgi.framework.wiring">BundleWiring</a></dd>
</dl>
<hr>
<br>
<pre>@ConsumerType
public interface <span class="strong">Wiring</span></pre>
<div class="block">A wiring for a resource. A wiring is associated with a resource and
represents the dependencies with other wirings.
<p>
Instances of this type must be <i>effectively immutable</i>. That is, for a
given instance of this interface, the methods defined by this interface must
always return the same result.</div>
</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>java.util.List<<a href="../../../org/osgi/resource/Wire.html" title="interface in org.osgi.resource">Wire</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/resource/Wiring.html#getProvidedResourceWires(java.lang.String)">getProvidedResourceWires</a></strong>(java.lang.String namespace)</code>
<div class="block">Returns the <a href="../../../org/osgi/resource/Wire.html" title="interface in org.osgi.resource"><code>Wire</code></a>s to the provided <a href="../../../org/osgi/resource/Capability.html" title="interface in org.osgi.resource"><code>capabilities</code></a>
of this wiring.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../org/osgi/resource/Wire.html" title="interface in org.osgi.resource">Wire</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/resource/Wiring.html#getRequiredResourceWires(java.lang.String)">getRequiredResourceWires</a></strong>(java.lang.String namespace)</code>
<div class="block">Returns the <a href="../../../org/osgi/resource/Wire.html" title="interface in org.osgi.resource"><code>Wire</code></a>s to the <a href="../../../org/osgi/resource/Requirement.html" title="interface in org.osgi.resource"><code>requirements</code></a> in use
by this wiring.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/osgi/resource/Resource.html" title="interface in org.osgi.resource">Resource</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/resource/Wiring.html#getResource()">getResource</a></strong>()</code>
<div class="block">Returns the resource associated with this wiring.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../org/osgi/resource/Capability.html" title="interface in org.osgi.resource">Capability</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/resource/Wiring.html#getResourceCapabilities(java.lang.String)">getResourceCapabilities</a></strong>(java.lang.String namespace)</code>
<div class="block">Returns the capabilities provided by this wiring.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../../org/osgi/resource/Requirement.html" title="interface in org.osgi.resource">Requirement</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/resource/Wiring.html#getResourceRequirements(java.lang.String)">getResourceRequirements</a></strong>(java.lang.String namespace)</code>
<div class="block">Returns the requirements of this wiring.</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="getResourceCapabilities(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceCapabilities</h4>
<pre>java.util.List<<a href="../../../org/osgi/resource/Capability.html" title="interface in org.osgi.resource">Capability</a>> getResourceCapabilities(java.lang.String namespace)</pre>
<div class="block">Returns the capabilities provided by this wiring.
<p>
Only capabilities considered by the resolver are returned. For example,
capabilities with <a href="../../../org/osgi/resource/Namespace.html#CAPABILITY_EFFECTIVE_DIRECTIVE"><code>effective</code></a> directive not equal to <a href="../../../org/osgi/resource/Namespace.html#EFFECTIVE_RESOLVE"><code>resolve</code></a> are not returned.
<p>
A capability may not be required by any wiring and thus there may be no
<a href="../../../org/osgi/resource/Wiring.html#getProvidedResourceWires(java.lang.String)"><code>wires</code></a> for the capability.
<p>
A wiring for a non-fragment resource provides a subset of the declared
capabilities from the resource and all attached fragment
resources<sup>†</sup>. Not all declared capabilities may be
provided since some may be discarded. For example, if a package is
declared to be both exported and imported, only one is selected and the
other is discarded.
<p>
A wiring for a fragment resource with a symbolic name must provide
exactly one <code>osgi.identity</code> capability.
<p>
† The <code>osgi.identity</code> capability provided by attached
fragment resource must not be included in the capabilities of the host
wiring.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>namespace</code> - The namespace of the capabilities to return or
<code>null</code> to return the capabilities from all namespaces.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A list containing a snapshot of the <a href="../../../org/osgi/resource/Capability.html" title="interface in org.osgi.resource"><code>Capability</code></a>s, or an
empty list if this wiring provides no capabilities in the
specified namespace. For a given namespace, the list contains the
capabilities in the order the capabilities were specified in the
manifests of the <a href="../../../org/osgi/resource/Wiring.html#getResource()"><code>resource</code></a> and the attached
fragment resources<sup>†</sup> of this wiring. There is no
ordering defined between capabilities in different namespaces.</dd></dl>
</li>
</ul>
<a name="getResourceRequirements(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceRequirements</h4>
<pre>java.util.List<<a href="../../../org/osgi/resource/Requirement.html" title="interface in org.osgi.resource">Requirement</a>> getResourceRequirements(java.lang.String namespace)</pre>
<div class="block">Returns the requirements of this wiring.
<p>
Only requirements considered by the resolver are returned. For example,
requirements with <a href="../../../org/osgi/resource/Namespace.html#REQUIREMENT_EFFECTIVE_DIRECTIVE"><code>effective</code></a> directive not equal to <a href="../../../org/osgi/resource/Namespace.html#EFFECTIVE_RESOLVE"><code>resolve</code></a> are not returned.
<p>
A wiring for a non-fragment resource has a subset of the declared
requirements from the resource and all attached fragment resources. Not
all declared requirements may be present since some may be discarded. For
example, if a package is declared to be optionally imported and is not
actually imported, the requirement must be discarded.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>namespace</code> - The namespace of the requirements to return or
<code>null</code> to return the requirements from all namespaces.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A list containing a snapshot of the <a href="../../../org/osgi/resource/Requirement.html" title="interface in org.osgi.resource"><code>Requirement</code></a>s, or an
empty list if this wiring uses no requirements in the specified
namespace. For a given namespace, the list contains the
requirements in the order the requirements were specified in the
manifests of the <a href="../../../org/osgi/resource/Wiring.html#getResource()"><code>resource</code></a> and the attached
fragment resources of this wiring. There is no ordering defined
between requirements in different namespaces.</dd></dl>
</li>
</ul>
<a name="getProvidedResourceWires(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProvidedResourceWires</h4>
<pre>java.util.List<<a href="../../../org/osgi/resource/Wire.html" title="interface in org.osgi.resource">Wire</a>> getProvidedResourceWires(java.lang.String namespace)</pre>
<div class="block">Returns the <a href="../../../org/osgi/resource/Wire.html" title="interface in org.osgi.resource"><code>Wire</code></a>s to the provided <a href="../../../org/osgi/resource/Capability.html" title="interface in org.osgi.resource"><code>capabilities</code></a>
of this wiring.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>namespace</code> - The namespace of the capabilities for which to return
wires or <code>null</code> to return the wires for the capabilities in
all namespaces.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A list containing a snapshot of the <a href="../../../org/osgi/resource/Wire.html" title="interface in org.osgi.resource"><code>Wire</code></a>s for the
<a href="../../../org/osgi/resource/Capability.html" title="interface in org.osgi.resource"><code>capabilities</code></a> of this wiring, or an empty list
if this wiring has no capabilities in the specified namespace.
For a given namespace, the list contains the wires in the order
the capabilities were specified in the manifests of the
<a href="../../../org/osgi/resource/Wiring.html#getResource()"><code>resource</code></a> and the attached fragment
resources of this wiring. There is no ordering defined between
capabilities in different namespaces.</dd></dl>
</li>
</ul>
<a name="getRequiredResourceWires(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequiredResourceWires</h4>
<pre>java.util.List<<a href="../../../org/osgi/resource/Wire.html" title="interface in org.osgi.resource">Wire</a>> getRequiredResourceWires(java.lang.String namespace)</pre>
<div class="block">Returns the <a href="../../../org/osgi/resource/Wire.html" title="interface in org.osgi.resource"><code>Wire</code></a>s to the <a href="../../../org/osgi/resource/Requirement.html" title="interface in org.osgi.resource"><code>requirements</code></a> in use
by this wiring.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>namespace</code> - The namespace of the requirements for which to return
wires or <code>null</code> to return the wires for the requirements in
all namespaces.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A list containing a snapshot of the <a href="../../../org/osgi/resource/Wire.html" title="interface in org.osgi.resource"><code>Wire</code></a>s for the
<a href="../../../org/osgi/resource/Requirement.html" title="interface in org.osgi.resource"><code>requirements</code></a> of this wiring, or an empty list
if this wiring has no requirements in the specified namespace.
For a given namespace, the list contains the wires in the order
the requirements were specified in the manifests of the
<a href="../../../org/osgi/resource/Wiring.html#getResource()"><code>resource</code></a> and the attached fragment
resources of this wiring. There is no ordering defined between
requirements in different namespaces.</dd></dl>
</li>
</ul>
<a name="getResource()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getResource</h4>
<pre><a href="../../../org/osgi/resource/Resource.html" title="interface in org.osgi.resource">Resource</a> getResource()</pre>
<div class="block">Returns the resource associated with this wiring.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The resource associated with this wiring.</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/resource/Wire.html" title="interface in org.osgi.resource"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/osgi/resource/Wiring.html" target="_top">Frames</a></li>
<li><a href="Wiring.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>
|