/usr/share/doc/libjdom2-java/api/org/jdom2/util/NamespaceStack.html is in libjdom2-java-doc 2.0.6-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 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 | <!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 Sat May 24 05:15:00 UTC 2014 -->
<title>NamespaceStack (JDOM v2.x)</title>
<meta name="date" content="2014-05-24">
<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="NamespaceStack (JDOM v2.x)";
}
//-->
</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/NamespaceStack.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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>JDOM<br><font size='-1'>2.x</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jdom2/util/IteratorIterable.html" title="interface in org.jdom2.util"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom2/util/NamespaceStack.html" target="_top">Frames</a></li>
<li><a href="NamespaceStack.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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.jdom2.util</div>
<h2 title="Class NamespaceStack" class="title">Class NamespaceStack</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.jdom2.util.NamespaceStack</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Iterable<<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">NamespaceStack</span>
extends java.lang.Object
implements java.lang.Iterable<<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>></pre>
<div class="block">A high-performance stack for processing those Namespaces that are introduced
or are in-scope at a point in an Element hierarchy.
<p>
This stack implements the 'Namespace Rules' which XML uses, where a Namespace
'redefines' an existing Namespace if they share the same prefix. This class
is intended to provide a high-performance mechanism for calculating the
Namespace scope for an Element, and identifying what Namespaces an Element
introduces in to the scope. This is not a validation tool.
<p>
This class implements Iterable which means it can be used in the context
of a for-each type loop:
<br>
<code><pre>
NamespaceStack namespacestack = new NamespaceStack();
for (Namespace ns : namespacestack) {
...
}
</pre></code>
The Iteration in the above example will return those Namespaces which are
in-scope for the current level of the stack. The Namespace order will follow
the JDOM 'standard'. The first namespace will be the Element's Namespace. The
subsequent Namespaces will be the other in-scope namespaces in alphabetical
order by the Namespace prefix.
<p>
NamespaceStack does not validate the push()/pop() cycles. It does not ensure
that the pop() is for the same element that was previously pushed. Further,
it does not check to make sure that the pushed() Element is the natural child
of the previously pushed() Element.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Rolf Lear</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/jdom2/util/NamespaceStack.html#NamespaceStack()">NamespaceStack</a></strong>()</code>
<div class="block">Create a NamespaceWalker ready to use as a stack.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/jdom2/util/NamespaceStack.html#NamespaceStack(org.jdom2.Namespace[])">NamespaceStack</a></strong>(<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>[] seed)</code>
<div class="block">Create a NamespaceWalker ready to use as a stack.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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.lang.Iterable<<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/util/NamespaceStack.html#addedForward()">addedForward</a></strong>()</code>
<div class="block">Return an Iterable containing all the Namespaces introduced to the
current-level's scope.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Iterable<<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/util/NamespaceStack.html#addedReverse()">addedReverse</a></strong>()</code>
<div class="block">Return an Iterable containing all the Namespaces introduced to the
current-level's scope but in reverse order to <a href="../../../org/jdom2/util/NamespaceStack.html#addedForward()"><code>addedForward()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/util/NamespaceStack.html#getScope()">getScope</a></strong>()</code>
<div class="block">Return a new array instance representing the current scope.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/util/NamespaceStack.html#isInScope(org.jdom2.Namespace)">isInScope</a></strong>(<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a> ns)</code>
<div class="block">Inspect the current scope and return true if the specified namespace is
in scope.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Iterator<<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/util/NamespaceStack.html#iterator()">iterator</a></strong>()</code>
<div class="block">Get all the Namespaces in-scope at the current level of the stack.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/util/NamespaceStack.html#pop()">pop</a></strong>()</code>
<div class="block">Restore stack to the level prior to the current one.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/util/NamespaceStack.html#push(org.jdom2.Attribute)">push</a></strong>(<a href="../../../org/jdom2/Attribute.html" title="class in org.jdom2">Attribute</a> att)</code>
<div class="block">Create a new in-scope level for the Stack based on an Attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/util/NamespaceStack.html#push(org.jdom2.Element)">push</a></strong>(<a href="../../../org/jdom2/Element.html" title="class in org.jdom2">Element</a> element)</code>
<div class="block">Create a new in-scope level for the Stack based on an Element.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="NamespaceStack()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NamespaceStack</h4>
<pre>public NamespaceStack()</pre>
<div class="block">Create a NamespaceWalker ready to use as a stack.
<br></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/jdom2/util/NamespaceStack.html#push(org.jdom2.Element)"><code>for comprehensive notes.</code></a></dd></dl>
</li>
</ul>
<a name="NamespaceStack(org.jdom2.Namespace[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NamespaceStack</h4>
<pre>public NamespaceStack(<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>[] seed)</pre>
<div class="block">Create a NamespaceWalker ready to use as a stack.
<br></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>seed</code> - The namespaces to set as the top level of the stack.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/jdom2/util/NamespaceStack.html#push(org.jdom2.Element)"><code>for comprehensive notes.</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="push(org.jdom2.Element)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>push</h4>
<pre>public void push(<a href="../../../org/jdom2/Element.html" title="class in org.jdom2">Element</a> element)</pre>
<div class="block">Create a new in-scope level for the Stack based on an Element.
<br>
The Namespaces associated with the input Element are used to modify the
'in-scope' Namespaces in this NamespaceStack.
<br>
The following 'rules' will be applied:
<ul>
<li>Namespaces used in the input Element that were not part of the previous
scope will be added to the new scope level in the stack.
<li>If a new Namespace is added to the scope, but the previous scope
already had a namespace with the same prefix, then that previous
namespace is removed from the new scope (the new Namespace replaces
the previous namespace with the same prefix).
<li>The order of the in-scope Namespaces will always be: first the
Namespace of the input Element followed by all other in-scope
Namespaces sorted alphabetically by prefix.
<li>The new in-scope Namespace values will be available in this class's
iterator() method (which is available as part of this class's
<i>Iterable</i> implementation.
<li>The namespaces added to the scope by the input Element will be
available in the <a href="../../../org/jdom2/util/NamespaceStack.html#addedForward()"><code>addedForward()</code></a> Iterable. The order of
the added Namespaces follows the same rules as above: first the
Element Namespace (only if that Namespace is actually added) followed
by the other added namespaces in alphabetical-by-prefix order.
<li>The same added namespaces are also available in reverse order in
the <a href="../../../org/jdom2/util/NamespaceStack.html#addedReverse()"><code>addedReverse()</code></a> Iterable.
</ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - The element at the new level of the stack.</dd></dl>
</li>
</ul>
<a name="push(org.jdom2.Attribute)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>push</h4>
<pre>public void push(<a href="../../../org/jdom2/Attribute.html" title="class in org.jdom2">Attribute</a> att)</pre>
<div class="block">Create a new in-scope level for the Stack based on an Attribute.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>att</code> - The attribute to contribute to the namespace scope.</dd></dl>
</li>
</ul>
<a name="pop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pop</h4>
<pre>public void pop()</pre>
<div class="block">Restore stack to the level prior to the current one. The various Iterator
methods will thus return the data at the previous level.</div>
</li>
</ul>
<a name="addedForward()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addedForward</h4>
<pre>public java.lang.Iterable<<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>> addedForward()</pre>
<div class="block">Return an Iterable containing all the Namespaces introduced to the
current-level's scope.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A read-only Iterable containing added Namespaces (may be empty);</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/jdom2/util/NamespaceStack.html#push(org.jdom2.Element)"><code>for the details on the data order.</code></a></dd></dl>
</li>
</ul>
<a name="addedReverse()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addedReverse</h4>
<pre>public java.lang.Iterable<<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>> addedReverse()</pre>
<div class="block">Return an Iterable containing all the Namespaces introduced to the
current-level's scope but in reverse order to <a href="../../../org/jdom2/util/NamespaceStack.html#addedForward()"><code>addedForward()</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A read-only Iterable containing added Namespaces (may be empty);</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/jdom2/util/NamespaceStack.html#push(org.jdom2.Element)"><code>for the details on the data order.</code></a></dd></dl>
</li>
</ul>
<a name="iterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public java.util.Iterator<<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>> iterator()</pre>
<div class="block">Get all the Namespaces in-scope at the current level of the stack.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>iterator</code> in interface <code>java.lang.Iterable<<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>A read-only Iterator containing added Namespaces (may be empty);</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/jdom2/util/NamespaceStack.html#push(org.jdom2.Element)"><code>for the details on the data order.</code></a></dd></dl>
</li>
</ul>
<a name="getScope()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScope</h4>
<pre>public <a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>[] getScope()</pre>
<div class="block">Return a new array instance representing the current scope.
Modifying the returned array will not affect this scope.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a copy of the current scope.</dd></dl>
</li>
</ul>
<a name="isInScope(org.jdom2.Namespace)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isInScope</h4>
<pre>public boolean isInScope(<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a> ns)</pre>
<div class="block">Inspect the current scope and return true if the specified namespace is
in scope.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ns</code> - The Namespace to check</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the current scope contains that Namespace.</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/NamespaceStack.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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>JDOM<br><font size='-1'>2.x</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jdom2/util/IteratorIterable.html" title="interface in org.jdom2.util"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom2/util/NamespaceStack.html" target="_top">Frames</a></li>
<li><a href="NamespaceStack.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright ? 2014 Jason Hunter, Brett McLaughlin. All Rights Reserved.</small></p>
</body>
</html>
|