/usr/share/doc/libjdom2-java/api/org/jdom2/NamespaceAware.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 | <!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:14:59 UTC 2014 -->
<title>NamespaceAware (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="NamespaceAware (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/NamespaceAware.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/Namespace.html" title="class in org.jdom2"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jdom2/NamespaceAware.html" target="_top">Frames</a></li>
<li><a href="NamespaceAware.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.jdom2</div>
<h2 title="Interface NamespaceAware" class="title">Interface NamespaceAware</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2">Parent</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../org/jdom2/Attribute.html" title="class in org.jdom2">Attribute</a>, <a href="../../org/jdom2/CDATA.html" title="class in org.jdom2">CDATA</a>, <a href="../../org/jdom2/Comment.html" title="class in org.jdom2">Comment</a>, <a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>, <a href="../../org/jdom2/DocType.html" title="class in org.jdom2">DocType</a>, <a href="../../org/jdom2/Document.html" title="class in org.jdom2">Document</a>, <a href="../../org/jdom2/Element.html" title="class in org.jdom2">Element</a>, <a href="../../org/jdom2/EntityRef.html" title="class in org.jdom2">EntityRef</a>, <a href="../../org/jdom2/located/LocatedCDATA.html" title="class in org.jdom2.located">LocatedCDATA</a>, <a href="../../org/jdom2/located/LocatedComment.html" title="class in org.jdom2.located">LocatedComment</a>, <a href="../../org/jdom2/located/LocatedDocType.html" title="class in org.jdom2.located">LocatedDocType</a>, <a href="../../org/jdom2/located/LocatedElement.html" title="class in org.jdom2.located">LocatedElement</a>, <a href="../../org/jdom2/located/LocatedEntityRef.html" title="class in org.jdom2.located">LocatedEntityRef</a>, <a href="../../org/jdom2/located/LocatedProcessingInstruction.html" title="class in org.jdom2.located">LocatedProcessingInstruction</a>, <a href="../../org/jdom2/located/LocatedText.html" title="class in org.jdom2.located">LocatedText</a>, <a href="../../org/jdom2/ProcessingInstruction.html" title="class in org.jdom2">ProcessingInstruction</a>, <a href="../../org/jdom2/Text.html" title="class in org.jdom2">Text</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">NamespaceAware</span></pre>
<div class="block">Classes implementing this interface are all sensitive to their
<a href="../../org/jdom2/Namespace.html" title="class in org.jdom2"><code>Namespace</code></a> context. All the core JDOM classes are NamespaceAware
(<a href="../../org/jdom2/Parent.html" title="interface in org.jdom2"><code>Parent</code></a> and subtypes, <a href="../../org/jdom2/Content.html" title="class in org.jdom2"><code>Content</code></a> and subtypes, and
<a href="../../org/jdom2/Attribute.html" title="class in org.jdom2"><code>Attribute</code></a>). You can use the methods that this interface provides
to query the Namespace context.
<p>
JDOM2 introduces a consistency in reporting Namespace context. XML standards
do not dictate any conditions on Namespace reporting or ordering, but
consistency is valuable for user-friendliness. As a result JDOM2 imposes a
useful order on the Namespace context for XML content.
<p>
The order for Namespace reporting is:
<ol>
<li>If the item 'has' a Namespace (Element, Attribute) then that Namespace is
reported.
<li>The remaining Namespaces are reported in alphabetical order by prefix.
</ol>
<p>
The XML namespace (bound to the prefix "xml" - see
<a href="../../org/jdom2/Namespace.html#XML_NAMESPACE"><code>Namespace.XML_NAMESPACE</code></a> ) is always in every scope. It is always
introduced in <a href="../../org/jdom2/Document.html" title="class in org.jdom2"><code>Document</code></a>, and in all other NamespaceAware instances it
is introduced if that content is detached.
<p>
See the individualised documentation for each implementing type for
additional specific details. The following section is a description of how
Namespaces are managed in the Element class.
<p>
<h2>The Element Namespace Scope</h2>
The 'default' Namespace is a source of confusion, but it is simply the
Namespace which is in-scope for an Element that has no Namespace prefix
(prefix is "" but it could have any Namespace URI). There will always be
exactly one Namespace that is in-scope for an element that has no prefix.
<p>
All Elements are in a Namespace. Elements will be in
<a href="../../org/jdom2/Namespace.html#NO_NAMESPACE"><code>Namespace.NO_NAMESPACE</code></a> unless a different Namespace was supplied as
part of the Element Constructor, or later modified by the
<a href="../../org/jdom2/Element.html#setNamespace(org.jdom2.Namespace)"><code>Element.setNamespace(Namespace)</code></a> method.
<p>
In addition to the Element's Namespace, there could be other Namespaces that
are 'in scope' for the Element. The set of Namespaces that are in scope for
an Element is the union of five sets:
<table>
<tr>
<th valign="top">XML</th>
<td>
There is always exactly one member of this set,
<a href="../../org/jdom2/Namespace.html#XML_NAMESPACE"><code>Namespace.XML_NAMESPACE</code></a>.
<br>
This set cannot be changed.
</td>
</tr>
<tr>
<th valign="top">Element</th>
<td>
There is always exactly one member of this set, and it can be retrieved
or set with the methods <a href="../../org/jdom2/Element.html#getNamespace()"><code>Element.getNamespace()</code></a> and
<a href="../../org/jdom2/Element.html#setNamespace(org.jdom2.Namespace)"><code>Element.setNamespace(Namespace)</code></a> respectively.
</td>
</tr>
<tr>
<th valign="top">Attribute</th>
<td>
This is the set of distinct Namespaces that are used on Attributes. You
can modify the set by adding and removing Attributes to the Element.
<p>
<b>NOTE:</b>
The <a href="../../org/jdom2/Namespace.html#NO_NAMESPACE"><code>Namespace.NO_NAMESPACE</code></a> Namespace is always the
<i>default</i> Namespace for attributes (the Namespace that has no
prefix). Thus there may be a special case with this Namespace, because
if there is a different <i>default</i> Namespace for the Element, then
the Namespace.NO_NAMESPACE Namespace is not part of the Element's in-scope
Namespace set (the Element cannot have two Namespaces in scope with the
same prefix - "").
</td>
</tr>
<tr>
<th valign="top">Additional</th>
<td>
This set is maintained by the two methods <a href="../../org/jdom2/Element.html#addNamespaceDeclaration(org.jdom2.Namespace)"><code>Element.addNamespaceDeclaration(Namespace)</code></a>
and <a href="../../org/jdom2/Element.html#removeNamespaceDeclaration(org.jdom2.Namespace)"><code>Element.removeNamespaceDeclaration(Namespace)</code></a>. You can get the full set
of additional Namespaces with <a href="../../org/jdom2/Element.html#getAdditionalNamespaces()"><code>Element.getAdditionalNamespaces()</code></a>
</td>
</tr>
<tr>
<th valign="top">Inherited</th>
<td>
This last set is somewhat dynamic because only those Namespaces on the
parent Element which are not re-defined by this Element will be
inherited. A Namespace is redefined by setting a new Namespace with the
same prefix, but a different URI. If you set a Namespace on the Element
(or add a Namespace declaration or set an Attribute) with the same
prefix as another Namespace that would have been otherwise inherited,
then that other Namespace will no longer be inherited.
</td>
</tr>
</table>
<p>
Since you cannot change the Namespace.XML_NAMESPACE, and the 'inherited' Namespace set
is dynamic, the remaining Namespace sets are the most interesting from a JDOM
perspective. JDOM validates all modifications that affect the Namespaces in
scope for an Element. An IllegalAddException will be thrown if you attempt to
add a new Namespace to the in-scope set if a different Namespace with the
same prefix is already part of one of these three sets (Element, Attribute,
or Additional).</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>JDOM2</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Rolf Lear</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>java.util.List<<a href="../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/NamespaceAware.html#getNamespacesInherited()">getNamespacesInherited</a></strong>()</code>
<div class="block">Obtain a list of all namespaces that are in scope for this content, but
were not introduced by this content.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/NamespaceAware.html#getNamespacesInScope()">getNamespacesInScope</a></strong>()</code>
<div class="block">Obtain a list of all namespaces that are in scope for the current
content.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/NamespaceAware.html#getNamespacesIntroduced()">getNamespacesIntroduced</a></strong>()</code>
<div class="block">Obtain a list of all namespaces that are introduced to the XML tree by
this node.</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="getNamespacesInScope()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespacesInScope</h4>
<pre>java.util.List<<a href="../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>> getNamespacesInScope()</pre>
<div class="block">Obtain a list of all namespaces that are in scope for the current
content.
<p>
The contents of this list will always be the combination of
getNamespacesIntroduced() and getNamespacesInherited().
<p>
See <a href="../../org/jdom2/NamespaceAware.html" title="interface in org.jdom2"><code>NamespaceAware</code></a> documentation for details on what the order of the
Namespaces will be in the returned list.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a read-only list of Namespaces.</dd></dl>
</li>
</ul>
<a name="getNamespacesIntroduced()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespacesIntroduced</h4>
<pre>java.util.List<<a href="../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>> getNamespacesIntroduced()</pre>
<div class="block">Obtain a list of all namespaces that are introduced to the XML tree by
this node. Only Elements and Attributes can introduce namespaces, so all
other Content types will return an empty list.
<p>
The contents of this list will always be a subset (but in the same order)
of getNamespacesInScope(), and will never intersect
getNamspacesInherited()</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a read-only list of Namespaces.</dd></dl>
</li>
</ul>
<a name="getNamespacesInherited()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getNamespacesInherited</h4>
<pre>java.util.List<<a href="../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>> getNamespacesInherited()</pre>
<div class="block">Obtain a list of all namespaces that are in scope for this content, but
were not introduced by this content.
<p>
The contents of this list will always be a subset (but in the same order)
of getNamespacesInScope(), and will never intersect
getNamspacesIntroduced()</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a read-only list of Namespaces.</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/NamespaceAware.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/Namespace.html" title="class in org.jdom2"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jdom2/NamespaceAware.html" target="_top">Frames</a></li>
<li><a href="NamespaceAware.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 ======= -->
<p class="legalCopy"><small>Copyright ? 2014 Jason Hunter, Brett McLaughlin. All Rights Reserved.</small></p>
</body>
</html>
|