/usr/share/doc/libjdom2-java/api/org/jdom2/Parent.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 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 | <!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>Parent (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="Parent (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/Parent.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/NamespaceAware.html" title="interface in org.jdom2"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/jdom2/ProcessingInstruction.html" title="class in org.jdom2"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jdom2/Parent.html" target="_top">Frames</a></li>
<li><a href="Parent.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 Parent" class="title">Interface Parent</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.lang.Cloneable, <a href="../../org/jdom2/NamespaceAware.html" title="interface in org.jdom2">NamespaceAware</a>, java.io.Serializable</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><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/located/LocatedElement.html" title="class in org.jdom2.located">LocatedElement</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Parent</span>
extends java.lang.Cloneable, <a href="../../org/jdom2/NamespaceAware.html" title="interface in org.jdom2">NamespaceAware</a>, java.io.Serializable</pre>
<div class="block">Interface for JDOM objects which are allowed to contain
<a href="../../org/jdom2/Content.html" title="class in org.jdom2"><code>Content</code></a> content - <a href="../../org/jdom2/Element.html" title="class in org.jdom2"><code>Element</code></a> and <a href="../../org/jdom2/Document.html" title="class in org.jdom2"><code>Document</code></a>.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Bradley S. Huffman, Jason Hunter, Rolf Lear</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../org/jdom2/Content.html" title="class in org.jdom2"><code>Content</code></a>,
<a href="../../org/jdom2/Document.html" title="class in org.jdom2"><code>Document</code></a>,
<a href="../../org/jdom2/Element.html" title="class in org.jdom2"><code>Element</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><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2">Parent</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#addContent(java.util.Collection)">addContent</a></strong>(java.util.Collection<? extends <a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> c)</code>
<div class="block">Appends all children in the given collection to the end of
the content list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2">Parent</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#addContent(org.jdom2.Content)">addContent</a></strong>(<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> child)</code>
<div class="block">Appends the child to the end of the content list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2">Parent</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#addContent(int, java.util.Collection)">addContent</a></strong>(int index,
java.util.Collection<? extends <a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> c)</code>
<div class="block">Inserts the content in a collection into the content list
at the given index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2">Parent</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#addContent(int, org.jdom2.Content)">addContent</a></strong>(int index,
<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> child)</code>
<div class="block">Inserts the child into the content list at the given index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#canContainContent(org.jdom2.Content, int, boolean)">canContainContent</a></strong>(<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> content,
int index,
boolean replace)</code>
<div class="block">Test whether this Parent instance can contain the specified content
at the specified position.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#clone()">clone</a></strong>()</code>
<div class="block">Obtain a deep, unattached copy of this parent and it's children.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#cloneContent()">cloneContent</a></strong>()</code>
<div class="block">Returns a list containing detached clones of this parent's content list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#getContent()">getContent</a></strong>()</code>
<div class="block">Returns the full content of this parent as a <code>List</code>
which contains objects of type <a href="../../org/jdom2/Content.html" title="class in org.jdom2"><code>Content</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><E extends <a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> <br>java.util.List<E></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#getContent(org.jdom2.filter.Filter)">getContent</a></strong>(<a href="../../org/jdom2/filter/Filter.html" title="interface in org.jdom2.filter">Filter</a><E> filter)</code>
<div class="block">Returns as a <code>List</code> the content of
this parent that matches the supplied filter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#getContent(int)">getContent</a></strong>(int index)</code>
<div class="block">Returns the child at the given index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#getContentSize()">getContentSize</a></strong>()</code>
<div class="block">Returns the number of children in this parent's content list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/jdom2/util/IteratorIterable.html" title="interface in org.jdom2.util">IteratorIterable</a><<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#getDescendants()">getDescendants</a></strong>()</code>
<div class="block">Returns an <code>Iterator</code> that walks over all descendants
in document order.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><E extends <a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> <br><a href="../../org/jdom2/util/IteratorIterable.html" title="interface in org.jdom2.util">IteratorIterable</a><E></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#getDescendants(org.jdom2.filter.Filter)">getDescendants</a></strong>(<a href="../../org/jdom2/filter/Filter.html" title="interface in org.jdom2.filter">Filter</a><E> filter)</code>
<div class="block">Returns an <code>Iterator</code> that walks over all descendants
in document order applying the Filter to return only content that
match the filter rule.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/jdom2/Document.html" title="class in org.jdom2">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#getDocument()">getDocument</a></strong>()</code>
<div class="block">Return this parent's owning document or null if the branch containing
this parent is currently not attached to a document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2">Parent</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#getParent()">getParent</a></strong>()</code>
<div class="block">Return this parent's parent, or null if this parent is currently
not attached to another parent.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#indexOf(org.jdom2.Content)">indexOf</a></strong>(<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> child)</code>
<div class="block">Returns the index of the supplied child in the content list,
or -1 if not a child of this parent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#removeContent()">removeContent</a></strong>()</code>
<div class="block">Removes all content from this parent and returns the detached
children.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#removeContent(org.jdom2.Content)">removeContent</a></strong>(<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> child)</code>
<div class="block">Removes a single child node from the content list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><E extends <a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> <br>java.util.List<E></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#removeContent(org.jdom2.filter.Filter)">removeContent</a></strong>(<a href="../../org/jdom2/filter/Filter.html" title="interface in org.jdom2.filter">Filter</a><E> filter)</code>
<div class="block">Removes from this parent all child content matching the given filter
and returns a list of the detached children.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom2/Parent.html#removeContent(int)">removeContent</a></strong>(int index)</code>
<div class="block">Removes and returns the child at the given
index, or returns null if there's no such child.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.jdom2.NamespaceAware">
<!-- -->
</a>
<h3>Methods inherited from interface org.jdom2.<a href="../../org/jdom2/NamespaceAware.html" title="interface in org.jdom2">NamespaceAware</a></h3>
<code><a href="../../org/jdom2/NamespaceAware.html#getNamespacesInherited()">getNamespacesInherited</a>, <a href="../../org/jdom2/NamespaceAware.html#getNamespacesInScope()">getNamespacesInScope</a>, <a href="../../org/jdom2/NamespaceAware.html#getNamespacesIntroduced()">getNamespacesIntroduced</a></code></li>
</ul>
</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="getContentSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentSize</h4>
<pre>int getContentSize()</pre>
<div class="block">Returns the number of children in this parent's content list.
Children may be any <a href="../../org/jdom2/Content.html" title="class in org.jdom2"><code>Content</code></a> type.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>number of children</dd></dl>
</li>
</ul>
<a name="indexOf(org.jdom2.Content)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexOf</h4>
<pre>int indexOf(<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> child)</pre>
<div class="block">Returns the index of the supplied child in the content list,
or -1 if not a child of this parent.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>child</code> - child to search for</dd>
<dt><span class="strong">Returns:</span></dt><dd>index of child, or -1 if not found</dd></dl>
</li>
</ul>
<a name="cloneContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneContent</h4>
<pre>java.util.List<<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> cloneContent()</pre>
<div class="block">Returns a list containing detached clones of this parent's content list.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>list of cloned child content</dd></dl>
</li>
</ul>
<a name="getContent(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContent</h4>
<pre><a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> getContent(int index)</pre>
<div class="block">Returns the child at the given index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - location of desired child</dd>
<dt><span class="strong">Returns:</span></dt><dd>child at the given index</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if index is negative or beyond
the current number of children</dd>
<dd><code>java.lang.IllegalStateException</code> - if parent is a Document
and the root element is not set</dd></dl>
</li>
</ul>
<a name="getContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContent</h4>
<pre>java.util.List<<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> getContent()</pre>
<div class="block">Returns the full content of this parent as a <code>List</code>
which contains objects of type <a href="../../org/jdom2/Content.html" title="class in org.jdom2"><code>Content</code></a>. The returned list is
<b>"live"</b> and in document order. Any modifications
to it affect the element's actual contents. Modifications are checked
for conformance to XML 1.0 rules.
<p>
Sequential traversal through the List is best done with an Iterator
since the underlying implement of <code>List.size()</code> may
require walking the entire list and indexed lookups may require
starting at the beginning each time.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a list of the content of the parent</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if parent is a Document
and the root element is not set</dd></dl>
</li>
</ul>
<a name="getContent(org.jdom2.filter.Filter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContent</h4>
<pre><E extends <a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> java.util.List<E> getContent(<a href="../../org/jdom2/filter/Filter.html" title="interface in org.jdom2.filter">Filter</a><E> filter)</pre>
<div class="block">Returns as a <code>List</code> the content of
this parent that matches the supplied filter. The returned list is
<b>"live"</b> and in document order. Any modifications to it affect
the element's actual contents. Modifications are checked for
conformance to XML 1.0 rules.
<p>
Sequential traversal through the List is best done with an Iterator
since the underlying implement of <code>List.size()</code> may
require walking the entire list and indexed lookups may require
starting at the beginning each time.</div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - The Generic type of the returned content (the Filter's type)</dd><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - filter to apply</dd>
<dt><span class="strong">Returns:</span></dt><dd>a list of the content of the parent matching the filter</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if parent is a Document
and the root element is not set</dd></dl>
</li>
</ul>
<a name="removeContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeContent</h4>
<pre>java.util.List<<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> removeContent()</pre>
<div class="block">Removes all content from this parent and returns the detached
children.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>list of the old content detached from this parent</dd></dl>
</li>
</ul>
<a name="removeContent(org.jdom2.filter.Filter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeContent</h4>
<pre><E extends <a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> java.util.List<E> removeContent(<a href="../../org/jdom2/filter/Filter.html" title="interface in org.jdom2.filter">Filter</a><E> filter)</pre>
<div class="block">Removes from this parent all child content matching the given filter
and returns a list of the detached children.</div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - The Generic type of the content to remove.</dd><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - filter to apply</dd>
<dt><span class="strong">Returns:</span></dt><dd>list of the detached children matching the filter</dd></dl>
</li>
</ul>
<a name="removeContent(org.jdom2.Content)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeContent</h4>
<pre>boolean removeContent(<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> child)</pre>
<div class="block">Removes a single child node from the content list.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>child</code> - child to remove</dd>
<dt><span class="strong">Returns:</span></dt><dd>whether the removal occurred</dd></dl>
</li>
</ul>
<a name="removeContent(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeContent</h4>
<pre><a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> removeContent(int index)</pre>
<div class="block">Removes and returns the child at the given
index, or returns null if there's no such child.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index of child to remove</dd>
<dt><span class="strong">Returns:</span></dt><dd>detached child at given index or null if no</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if index is negative or beyond
the current number of children</dd></dl>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>java.lang.Object clone()</pre>
<div class="block">Obtain a deep, unattached copy of this parent and it's children.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a deep copy of this parent and it's children.</dd></dl>
</li>
</ul>
<a name="getDescendants()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescendants</h4>
<pre><a href="../../org/jdom2/util/IteratorIterable.html" title="interface in org.jdom2.util">IteratorIterable</a><<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> getDescendants()</pre>
<div class="block">Returns an <code>Iterator</code> that walks over all descendants
in document order.
<p>
Note that this method returns an IteratorIterable instance, which means
that you can use it either as an Iterator, or an Iterable, allowing both:
<p>
<pre>
for (Iterator<Content> it = parent.getDescendants();
it.hasNext();) {
Content c = it.next();
....
}
</pre>
and
<pre>
for (Content c : parent.getDescendants()) {
....
}
</pre>
The Iterator version is most useful if you need to do list modification
on the iterator (using remove()), and for compatibility with JDOM 1.x</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an iterator to walk descendants</dd></dl>
</li>
</ul>
<a name="getDescendants(org.jdom2.filter.Filter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescendants</h4>
<pre><E extends <a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> <a href="../../org/jdom2/util/IteratorIterable.html" title="interface in org.jdom2.util">IteratorIterable</a><E> getDescendants(<a href="../../org/jdom2/filter/Filter.html" title="interface in org.jdom2.filter">Filter</a><E> filter)</pre>
<div class="block">Returns an <code>Iterator</code> that walks over all descendants
in document order applying the Filter to return only content that
match the filter rule. With filters you can match only Elements,
only Comments, Elements or Comments, only Elements with a given name
and/or prefix, and so on.
<p>
Note that this method returns an IteratorIterable instance, which means
that you can use it either as an Iterator, or an Iterable, allowing both:
<p>
<pre>
for (Iterator<Element> it = parent.getDescendants(Filters.element());
it.hasNext();) {
Element e = it.next();
....
}
</pre>
and
<pre>
for (Element e : parent.getDescendants(Filters.element())) {
....
}
</pre>
The Iterator version is most useful if you need to do list modification
on the iterator (using remove()), and for compatibility with JDOM 1.x</div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - The generic type of the returned descendant data</dd><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - filter to select which descendants to see</dd>
<dt><span class="strong">Returns:</span></dt><dd>an iterator to walk descendants that match a filter</dd></dl>
</li>
</ul>
<a name="getParent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2">Parent</a> getParent()</pre>
<div class="block">Return this parent's parent, or null if this parent is currently
not attached to another parent. This is the same method as in Content but
also added to Parent to allow more easy up-the-tree walking.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>this parent's parent or null if none</dd></dl>
</li>
</ul>
<a name="getDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocument</h4>
<pre><a href="../../org/jdom2/Document.html" title="class in org.jdom2">Document</a> getDocument()</pre>
<div class="block">Return this parent's owning document or null if the branch containing
this parent is currently not attached to a document.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>this child's owning document or null if none</dd></dl>
</li>
</ul>
<a name="canContainContent(org.jdom2.Content, int, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canContainContent</h4>
<pre>void canContainContent(<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> content,
int index,
boolean replace)
throws <a href="../../org/jdom2/IllegalAddException.html" title="class in org.jdom2">IllegalAddException</a></pre>
<div class="block">Test whether this Parent instance can contain the specified content
at the specified position.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - The content to be checked</dd><dd><code>index</code> - The location where the content would be put.</dd><dd><code>replace</code> - true if the intention is to replace the content already at
the index.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/jdom2/IllegalAddException.html" title="class in org.jdom2">IllegalAddException</a></code> - if there is a problem with the content</dd></dl>
</li>
</ul>
<a name="addContent(org.jdom2.Content)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addContent</h4>
<pre><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2">Parent</a> addContent(<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> child)</pre>
<div class="block">Appends the child to the end of the content list.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>child</code> - child to append to end of content list</dd>
<dt><span class="strong">Returns:</span></dt><dd>the Parent instance on which the method was called</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/jdom2/IllegalAddException.html" title="class in org.jdom2">IllegalAddException</a></code> - if the given child already has a parent.</dd></dl>
</li>
</ul>
<a name="addContent(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addContent</h4>
<pre><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2">Parent</a> addContent(java.util.Collection<? extends <a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> c)</pre>
<div class="block">Appends all children in the given collection to the end of
the content list. In event of an exception during add the
original content will be unchanged and the objects in the supplied
collection will be unaltered.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - collection to append</dd>
<dt><span class="strong">Returns:</span></dt><dd>the document on which the method was called</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/jdom2/IllegalAddException.html" title="class in org.jdom2">IllegalAddException</a></code> - if any item in the collection
already has a parent or is of an illegal type.</dd></dl>
</li>
</ul>
<a name="addContent(int, org.jdom2.Content)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addContent</h4>
<pre><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2">Parent</a> addContent(int index,
<a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> child)</pre>
<div class="block">Inserts the child into the content list at the given index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - location for adding the collection</dd><dd><code>child</code> - child to insert</dd>
<dt><span class="strong">Returns:</span></dt><dd>the parent on which the method was called</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if index is negative or beyond
the current number of children</dd>
<dd><code><a href="../../org/jdom2/IllegalAddException.html" title="class in org.jdom2">IllegalAddException</a></code> - if the given child already has a parent.</dd></dl>
</li>
</ul>
<a name="addContent(int, java.util.Collection)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addContent</h4>
<pre><a href="../../org/jdom2/Parent.html" title="interface in org.jdom2">Parent</a> addContent(int index,
java.util.Collection<? extends <a href="../../org/jdom2/Content.html" title="class in org.jdom2">Content</a>> c)</pre>
<div class="block">Inserts the content in a collection into the content list
at the given index. In event of an exception the original content
will be unchanged and the objects in the supplied collection will be
unaltered.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - location for adding the collection</dd><dd><code>c</code> - collection to insert</dd>
<dt><span class="strong">Returns:</span></dt><dd>the parent on which the method was called</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if index is negative or beyond
the current number of children</dd>
<dd><code><a href="../../org/jdom2/IllegalAddException.html" title="class in org.jdom2">IllegalAddException</a></code> - if any item in the collection
already has a parent or is of an illegal type.</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/Parent.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/NamespaceAware.html" title="interface in org.jdom2"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/jdom2/ProcessingInstruction.html" title="class in org.jdom2"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jdom2/Parent.html" target="_top">Frames</a></li>
<li><a href="Parent.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>
|