/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/dmt/spi/MountPoint.html is in libosgi-compendium-java-doc 5.0.0-5.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>MountPoint</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MountPoint";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/service/dmt/spi/MountPlugin.html" title="interface in org.osgi.service.dmt.spi"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/dmt/spi/ReadableDataSession.html" title="interface in org.osgi.service.dmt.spi"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/osgi/service/dmt/spi/MountPoint.html" target="_top">Frames</a></li>
<li><a href="MountPoint.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.service.dmt.spi</div>
<h2 title="Interface MountPoint" class="title">Interface MountPoint</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">MountPoint</span></pre>
<div class="block">This interface can be implemented to represent a single mount point.
<p>
It provides function to get the absolute mounted uri and a shortcut method to
post events via the DmtAdmin.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/spi/MountPoint.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object other)</code>
<div class="block">This object must provide a suitable hash function such that a Mount Point
given in <a href="../../../../../org/osgi/service/dmt/spi/MountPlugin.html#mountPointAdded-org.osgi.service.dmt.spi.MountPoint-"><code>MountPlugin.mountPointAdded(MountPoint)</code></a> is equal to the
corresponding Mount Point in
<a href="../../../../../org/osgi/service/dmt/spi/MountPlugin.html#mountPointRemoved-org.osgi.service.dmt.spi.MountPoint-"><code>MountPlugin.mountPointRemoved(MountPoint)</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/spi/MountPoint.html#getMountPath--">getMountPath</a></span>()</code>
<div class="block">Provides the absolute mount path of this <code>MountPoint</code></div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/spi/MountPoint.html#hashCode--">hashCode</a></span>()</code>
<div class="block">This object must provide a suitable hash function such that a Mount Point
given in <a href="../../../../../org/osgi/service/dmt/spi/MountPlugin.html#mountPointAdded-org.osgi.service.dmt.spi.MountPoint-"><code>MountPlugin.mountPointAdded(MountPoint)</code></a> has the same
hashCode as the corresponding Mount Point in
<a href="../../../../../org/osgi/service/dmt/spi/MountPlugin.html#mountPointRemoved-org.osgi.service.dmt.spi.MountPoint-"><code>MountPlugin.mountPointRemoved(MountPoint)</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/spi/MountPoint.html#postEvent-java.lang.String-java.lang.String:A-java.util.Dictionary-">postEvent</a></span>(java.lang.String topic,
java.lang.String[] relativeURIs,
java.util.Dictionary properties)</code>
<div class="block">Posts an event via the DmtAdmin about changes in the current plugins
subtree.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/spi/MountPoint.html#postEvent-java.lang.String-java.lang.String:A-java.lang.String:A-java.util.Dictionary-">postEvent</a></span>(java.lang.String topic,
java.lang.String[] relativeURIs,
java.lang.String[] newRelativeURIs,
java.util.Dictionary properties)</code>
<div class="block">Posts an event via the DmtAdmin about changes in the current plugins
subtree.</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="getMountPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMountPath</h4>
<pre>java.lang.String[] getMountPath()</pre>
<div class="block">Provides the absolute mount path of this <code>MountPoint</code></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the absolute mount path of this <code>MountPoint</code></dd>
</dl>
</li>
</ul>
<a name="postEvent-java.lang.String-java.lang.String:A-java.util.Dictionary-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>postEvent</h4>
<pre>void postEvent(java.lang.String topic,
java.lang.String[] relativeURIs,
java.util.Dictionary properties)</pre>
<div class="block">Posts an event via the DmtAdmin about changes in the current plugins
subtree.
<p>
This method distributes Events asynchronously to the EventAdmin as well
as to matching local DmtEventListeners.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>topic</code> - the topic of the event to send. Valid values are:
<ul>
<li><code>org/osgi/service/dmt/DmtEvent/ADDED</code> if the change was
caused by an add action</li><li>
<code>org/osgi/service/dmt/DmtEvent/DELETED</code> if the change was
caused by a delete action</li><li>
<code>org/osgi/service/dmt/DmtEvent/REPLACED</code> if the change was
caused by a replace action</li>
</ul>
Must not be <code>null</code>.</dd>
<dd><code>relativeURIs</code> - an array of affected node <code>URI</code>'s. All
<code>URI</code>'s specified here are relative to the current
<code>MountPoint</code>'s mountPath. The value of this parameter
determines the value of the event property
<code>EVENT_PROPERTY_NODES</code>. An empty array or <code>null</code> is
permitted. In both cases the value of the events
<code>EVENT_PROPERTY_NODES</code> property will be set to an empty
array.</dd>
<dd><code>properties</code> - an optional parameter that can be provided to add
properties to the Event that is going to be send by the DMTAdmin.
If the properties contain a key <code>EVENT_PROPERTY_NODES</code>, then
the value of this property is ignored and will be overwritten by
<code>relativeURIs</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the topic has not one of the defined
values</dd>
</dl>
</li>
</ul>
<a name="postEvent-java.lang.String-java.lang.String:A-java.lang.String:A-java.util.Dictionary-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>postEvent</h4>
<pre>void postEvent(java.lang.String topic,
java.lang.String[] relativeURIs,
java.lang.String[] newRelativeURIs,
java.util.Dictionary properties)</pre>
<div class="block">Posts an event via the DmtAdmin about changes in the current plugins
subtree.
<p>
This method distributes Events asynchronously to the EventAdmin as well
as to matching local DmtEventListeners.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>topic</code> - the topic of the event to send. Valid values are:
<ul>
<li><code>org/osgi/service/dmt/DmtEvent/RENAMED</code> if the change
was caused by a rename action</li><li>
<code>org/osgi/service/dmt/DmtEvent/COPIED</code> if the change was
caused by a copy action</li>
</ul>
Must not be <code>null</code>.</dd>
<dd><code>relativeURIs</code> - an array of affected node <code>URI</code>'s.
<p>
All <code>URI</code>'s specified here are relative to the current
<code>MountPoint</code>'s mountPath. The value of this parameter
determines the value of the event property
<code>EVENT_PROPERTY_NODES</code>. An empty array or <code>null</code> is
permitted. In both cases the value of the events
<code>EVENT_PROPERTY_NODES</code> property will be set to an empty
array.</dd>
<dd><code>newRelativeURIs</code> - an array of affected node <code>URI</code>'s.The value
of this parameter determines the value of the event property
<code>EVENT_PROPERTY_NEW_NODES</code>. An empty array or <code>null</code>
is permitted. In both cases the value of the events
<code>EVENT_PROPERTY_NEW_NODES</code> property will be set to an empty
array.</dd>
<dd><code>properties</code> - an optional parameter that can be provided to add
properties to the Event that is going to be send by the DMTAdmin.
If the properties contain the keys <code>EVENT_PROPERTY_NODES</code> or
<code>EVENT_PROPERTY_NEW_NODES</code>, then the values of these
properties are ignored and will be overwritten by
<code>relativeURIs</code> and <code>newRelativeURIs</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the topic has not one of the defined
values</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>int hashCode()</pre>
<div class="block">This object must provide a suitable hash function such that a Mount Point
given in <a href="../../../../../org/osgi/service/dmt/spi/MountPlugin.html#mountPointAdded-org.osgi.service.dmt.spi.MountPoint-"><code>MountPlugin.mountPointAdded(MountPoint)</code></a> has the same
hashCode as the corresponding Mount Point in
<a href="../../../../../org/osgi/service/dmt/spi/MountPlugin.html#mountPointRemoved-org.osgi.service.dmt.spi.MountPoint-"><code>MountPlugin.mountPointRemoved(MountPoint)</code></a>.
<code>Object.hashCode()</code></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>equals</h4>
<pre>boolean equals(java.lang.Object other)</pre>
<div class="block">This object must provide a suitable hash function such that a Mount Point
given in <a href="../../../../../org/osgi/service/dmt/spi/MountPlugin.html#mountPointAdded-org.osgi.service.dmt.spi.MountPoint-"><code>MountPlugin.mountPointAdded(MountPoint)</code></a> is equal to the
corresponding Mount Point in
<a href="../../../../../org/osgi/service/dmt/spi/MountPlugin.html#mountPointRemoved-org.osgi.service.dmt.spi.MountPoint-"><code>MountPlugin.mountPointRemoved(MountPoint)</code></a>.
<code>Object.equals(Object)</code></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/service/dmt/spi/MountPlugin.html" title="interface in org.osgi.service.dmt.spi"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/dmt/spi/ReadableDataSession.html" title="interface in org.osgi.service.dmt.spi"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/osgi/service/dmt/spi/MountPoint.html" target="_top">Frames</a></li>
<li><a href="MountPoint.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>
|