/usr/share/doc/libjenkins-dom4j-java/api/org/dom4j/Branch.html is in libjenkins-dom4j-java-doc 1.6.1-jenkins-4-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 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 | <!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_65) on Thu Sep 04 18:10:37 UTC 2014 -->
<title>Branch (dom4j API)</title>
<meta name="date" content="2014-09-04">
<link rel="stylesheet" type="text/css" href="../../javadoc.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Branch (dom4j API)";
}
//-->
</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/Branch.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/dom4j/Attribute.html" title="interface in org.dom4j"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/dom4j/CDATA.html" title="interface in org.dom4j"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/dom4j/Branch.html" target="_top">Frames</a></li>
<li><a href="Branch.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.dom4j</div>
<h2 title="Interface Branch" class="title">Interface Branch</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="file:///usr/share/doc/default-jdk/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a>, <a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd>org.dom4j.tree.AbstractBranch, org.dom4j.tree.AbstractElement, org.dom4j.tree.BaseElement, <a href="../../org/dom4j/datatype/DatatypeElement.html" title="class in org.dom4j.datatype">DatatypeElement</a>, org.dom4j.tree.DefaultElement, <a href="../../org/dom4j/util/IndexedElement.html" title="class in org.dom4j.util">IndexedElement</a>, <a href="../../org/dom4j/util/NonLazyElement.html" title="class in org.dom4j.util">NonLazyElement</a>, <a href="../../org/dom4j/util/UserDataElement.html" title="class in org.dom4j.util">UserDataElement</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Branch</span>
extends <a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a></pre>
<div class="block"><p>
<code>Branch</code> interface defines the common behaviour for Nodes which
can contain child nodes (content) such as XML elements and documents. This
interface allows both elements and documents to be treated in a polymorphic
manner when changing or navigating child nodes (content).
</p></div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.32 $</dd>
<dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:jstrachan@apache.org">James Strachan </a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.dom4j.Node">
<!-- -->
</a>
<h3>Fields inherited from interface org.dom4j.<a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a></h3>
<code><a href="../../org/dom4j/Node.html#ANY_NODE">ANY_NODE</a>, <a href="../../org/dom4j/Node.html#ATTRIBUTE_NODE">ATTRIBUTE_NODE</a>, <a href="../../org/dom4j/Node.html#CDATA_SECTION_NODE">CDATA_SECTION_NODE</a>, <a href="../../org/dom4j/Node.html#COMMENT_NODE">COMMENT_NODE</a>, <a href="../../org/dom4j/Node.html#DOCUMENT_NODE">DOCUMENT_NODE</a>, <a href="../../org/dom4j/Node.html#DOCUMENT_TYPE_NODE">DOCUMENT_TYPE_NODE</a>, <a href="../../org/dom4j/Node.html#ELEMENT_NODE">ELEMENT_NODE</a>, <a href="../../org/dom4j/Node.html#ENTITY_REFERENCE_NODE">ENTITY_REFERENCE_NODE</a>, <a href="../../org/dom4j/Node.html#MAX_NODE_TYPE">MAX_NODE_TYPE</a>, <a href="../../org/dom4j/Node.html#NAMESPACE_NODE">NAMESPACE_NODE</a>, <a href="../../org/dom4j/Node.html#PROCESSING_INSTRUCTION_NODE">PROCESSING_INSTRUCTION_NODE</a>, <a href="../../org/dom4j/Node.html#TEXT_NODE">TEXT_NODE</a>, <a href="../../org/dom4j/Node.html#UNKNOWN_NODE">UNKNOWN_NODE</a></code></li>
</ul>
</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>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#add(org.dom4j.Comment)">add</a></strong>(<a href="../../org/dom4j/Comment.html" title="interface in org.dom4j">Comment</a> comment)</code>
<div class="block">Adds the given <code>Comment</code> to this branch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#add(org.dom4j.Element)">add</a></strong>(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> element)</code>
<div class="block">Adds the given <code>Element</code> to this branch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#add(org.dom4j.Node)">add</a></strong>(<a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> node)</code>
<div class="block">Adds the given <code>Node</code> or throws <a href="../../org/dom4j/IllegalAddException.html" title="class in org.dom4j"><code>IllegalAddException</code></a>
if the given node is not of a valid type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#add(org.dom4j.ProcessingInstruction)">add</a></strong>(<a href="../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a> pi)</code>
<div class="block">Adds the given <code>ProcessingInstruction</code> to this branch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#addElement(org.dom4j.QName)">addElement</a></strong>(<a href="../../org/dom4j/QName.html" title="class in org.dom4j">QName</a> qname)</code>
<div class="block">Adds a new <code>Element</code> node with the given <a href="../../org/dom4j/QName.html" title="class in org.dom4j"><code>QName</code></a>to
this branch and returns a reference to the new node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#addElement(java.lang.String)">addElement</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Adds a new <code>Element</code> node with the given name to this branch
and returns a reference to the new node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#addElement(java.lang.String,%20java.lang.String)">addElement</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> qualifiedName,
<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespaceURI)</code>
<div class="block">Adds a new <code>Element</code> node with the given qualified name and
namespace URI to this branch and returns a reference to the new node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#appendContent(org.dom4j.Branch)">appendContent</a></strong>(<a href="../../org/dom4j/Branch.html" title="interface in org.dom4j">Branch</a> branch)</code>
<div class="block">Appends the content of the given branch to this branch instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#clearContent()">clearContent</a></strong>()</code>
<div class="block">Clears the content for this branch, removing any <code>Node</code>
instances this branch may contain.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#content()">content</a></strong>()</code>
<div class="block">
Returns the content nodes of this branch as a backed <a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a>so that
the content of this branch may be modified directly using the
<a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a>interface.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#elementByID(java.lang.String)">elementByID</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> elementID)</code>
<div class="block">Returns the element of the given ID attribute value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#indexOf(org.dom4j.Node)">indexOf</a></strong>(<a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> node)</code>
<div class="block">Returns the index of the given node if it is a child node of this branch
or -1 if the given node is not a child node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#node(int)">node</a></strong>(int index)</code>
<div class="block">Returns the <code>Node</code> at the specified index position.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#nodeCount()">nodeCount</a></strong>()</code>
<div class="block">Returns the number of <code>Node</code> instances that this branch
contains.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#nodeIterator()">nodeIterator</a></strong>()</code>
<div class="block">Returns an iterator through the content nodes of this branch</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#normalize()">normalize</a></strong>()</code>
<div class="block">Puts all <code>Text</code> nodes in the full depth of the sub-tree
underneath this <code>Node</code>, including attribute nodes, into a
"normal" form where only structure (e.g., elements, comments, processing
instructions, CDATA sections, and entity references) separates
<code>Text</code> nodes, i.e., there are neither adjacent
<code>Text</code> nodes nor empty <code>Text</code> nodes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#processingInstruction(java.lang.String)">processingInstruction</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> target)</code>
<div class="block">DOCUMENT ME!</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#processingInstructions()">processingInstructions</a></strong>()</code>
<div class="block">
Returns a list of all the processing instructions in this branch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#processingInstructions(java.lang.String)">processingInstructions</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> target)</code>
<div class="block">
Returns a list of the processing instructions for the given target.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#remove(org.dom4j.Comment)">remove</a></strong>(<a href="../../org/dom4j/Comment.html" title="interface in org.dom4j">Comment</a> comment)</code>
<div class="block">Removes the given <code>Comment</code> if the node is an immediate
child of this branch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#remove(org.dom4j.Element)">remove</a></strong>(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> element)</code>
<div class="block">Removes the given <code>Element</code> if the node is an immediate
child of this branch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#remove(org.dom4j.Node)">remove</a></strong>(<a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> node)</code>
<div class="block">Removes the given <code>Node</code> if the node is an immediate child
of this branch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#remove(org.dom4j.ProcessingInstruction)">remove</a></strong>(<a href="../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a> pi)</code>
<div class="block">Removes the given <code>ProcessingInstruction</code> if the node is an
immediate child of this branch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#removeProcessingInstruction(java.lang.String)">removeProcessingInstruction</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> target)</code>
<div class="block">Removes the processing instruction for the given target if it exists</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#setContent(java.util.List)">setContent</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> content)</code>
<div class="block">Sets the contents of this branch as a <code>List</code> of
<code>Node</code> instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Branch.html#setProcessingInstructions(java.util.List)">setProcessingInstructions</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> listOfPIs)</code>
<div class="block">Sets all the processing instructions for this branch</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.dom4j.Node">
<!-- -->
</a>
<h3>Methods inherited from interface org.dom4j.<a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a></h3>
<code><a href="../../org/dom4j/Node.html#accept(org.dom4j.Visitor)">accept</a>, <a href="../../org/dom4j/Node.html#asXML()">asXML</a>, <a href="../../org/dom4j/Node.html#asXPathResult(org.dom4j.Element)">asXPathResult</a>, <a href="../../org/dom4j/Node.html#clone()">clone</a>, <a href="../../org/dom4j/Node.html#createXPath(java.lang.String)">createXPath</a>, <a href="../../org/dom4j/Node.html#detach()">detach</a>, <a href="../../org/dom4j/Node.html#getDocument()">getDocument</a>, <a href="../../org/dom4j/Node.html#getName()">getName</a>, <a href="../../org/dom4j/Node.html#getNodeType()">getNodeType</a>, <a href="../../org/dom4j/Node.html#getNodeTypeName()">getNodeTypeName</a>, <a href="../../org/dom4j/Node.html#getParent()">getParent</a>, <a href="../../org/dom4j/Node.html#getPath()">getPath</a>, <a href="../../org/dom4j/Node.html#getPath(org.dom4j.Element)">getPath</a>, <a href="../../org/dom4j/Node.html#getStringValue()">getStringValue</a>, <a href="../../org/dom4j/Node.html#getText()">getText</a>, <a href="../../org/dom4j/Node.html#getUniquePath()">getUniquePath</a>, <a href="../../org/dom4j/Node.html#getUniquePath(org.dom4j.Element)">getUniquePath</a>, <a href="../../org/dom4j/Node.html#hasContent()">hasContent</a>, <a href="../../org/dom4j/Node.html#isReadOnly()">isReadOnly</a>, <a href="../../org/dom4j/Node.html#matches(java.lang.String)">matches</a>, <a href="../../org/dom4j/Node.html#numberValueOf(java.lang.String)">numberValueOf</a>, <a href="../../org/dom4j/Node.html#selectNodes(java.lang.String)">selectNodes</a>, <a href="../../org/dom4j/Node.html#selectNodes(java.lang.String,%20java.lang.String)">selectNodes</a>, <a href="../../org/dom4j/Node.html#selectNodes(java.lang.String,%20java.lang.String,%20boolean)">selectNodes</a>, <a href="../../org/dom4j/Node.html#selectObject(java.lang.String)">selectObject</a>, <a href="../../org/dom4j/Node.html#selectSingleNode(java.lang.String)">selectSingleNode</a>, <a href="../../org/dom4j/Node.html#setDocument(org.dom4j.Document)">setDocument</a>, <a href="../../org/dom4j/Node.html#setName(java.lang.String)">setName</a>, <a href="../../org/dom4j/Node.html#setParent(org.dom4j.Element)">setParent</a>, <a href="../../org/dom4j/Node.html#setText(java.lang.String)">setText</a>, <a href="../../org/dom4j/Node.html#supportsParent()">supportsParent</a>, <a href="../../org/dom4j/Node.html#valueOf(java.lang.String)">valueOf</a>, <a href="../../org/dom4j/Node.html#write(java.io.Writer)">write</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="node(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>node</h4>
<pre><a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> node(int index)
throws <a href="file:///usr/share/doc/default-jdk/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></pre>
<div class="block">Returns the <code>Node</code> at the specified index position.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - the index of the node to return.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>Node</code> at the specified position.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - if the index is out of range (index < 0 || index >=
<a href="../../org/dom4j/Branch.html#nodeCount()"><code>nodeCount()</code></a>).</dd></dl>
</li>
</ul>
<a name="indexOf(org.dom4j.Node)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexOf</h4>
<pre>int indexOf(<a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> node)</pre>
<div class="block">Returns the index of the given node if it is a child node of this branch
or -1 if the given node is not a child node.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>node</code> - the content child node to find.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index of the given node starting at 0 or -1 if the node is
not a child node of this branch</dd></dl>
</li>
</ul>
<a name="nodeCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nodeCount</h4>
<pre>int nodeCount()</pre>
<div class="block">Returns the number of <code>Node</code> instances that this branch
contains.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of nodes this branch contains</dd></dl>
</li>
</ul>
<a name="elementByID(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>elementByID</h4>
<pre><a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> elementByID(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> elementID)</pre>
<div class="block">Returns the element of the given ID attribute value. If this tree is
capable of understanding which attribute value should be used for the ID
then it should be used, otherwise this method should return null.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>elementID</code> - DOCUMENT ME!</dd>
<dt><span class="strong">Returns:</span></dt><dd>DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="content()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>content</h4>
<pre><a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> content()</pre>
<div class="block"><p>
Returns the content nodes of this branch as a backed <a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a>so that
the content of this branch may be modified directly using the
<a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a>interface. The <code>List</code> is backed by the
<code>Branch</code> so that changes to the list are reflected in the
branch and vice versa.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the nodes that this branch contains as a <code>List</code></dd></dl>
</li>
</ul>
<a name="nodeIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nodeIterator</h4>
<pre><a href="file:///usr/share/doc/default-jdk/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a> nodeIterator()</pre>
<div class="block">Returns an iterator through the content nodes of this branch</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an iterator through the content nodes of this branch</dd></dl>
</li>
</ul>
<a name="setContent(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContent</h4>
<pre>void setContent(<a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> content)</pre>
<div class="block">Sets the contents of this branch as a <code>List</code> of
<code>Node</code> instances.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - is the list of nodes to use as the content for this branch.</dd></dl>
</li>
</ul>
<a name="appendContent(org.dom4j.Branch)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendContent</h4>
<pre>void appendContent(<a href="../../org/dom4j/Branch.html" title="interface in org.dom4j">Branch</a> branch)</pre>
<div class="block">Appends the content of the given branch to this branch instance. This
method behaves like the <a href="file:///usr/share/doc/default-jdk/api/java/util/Collection.html?is-external=true#addAll(java.util.Collection)" title="class or interface in java.util"><code>Collection.addAll(java.util.Collection)</code></a> method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>branch</code> - is the branch whose content will be added to me.</dd></dl>
</li>
</ul>
<a name="clearContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearContent</h4>
<pre>void clearContent()</pre>
<div class="block">Clears the content for this branch, removing any <code>Node</code>
instances this branch may contain.</div>
</li>
</ul>
<a name="processingInstructions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processingInstructions</h4>
<pre><a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> processingInstructions()</pre>
<div class="block"><p>
Returns a list of all the processing instructions in this branch. The
list is backed by this branch so that changes to the list will be
reflected in the branch but the reverse is not the case.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a backed list of the processing instructions</dd></dl>
</li>
</ul>
<a name="processingInstructions(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processingInstructions</h4>
<pre><a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> processingInstructions(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> target)</pre>
<div class="block"><p>
Returns a list of the processing instructions for the given target. The
list is backed by this branch so that changes to the list will be
reflected in the branch but the reverse is not the case.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - DOCUMENT ME!</dd>
<dt><span class="strong">Returns:</span></dt><dd>a backed list of the processing instructions</dd></dl>
</li>
</ul>
<a name="processingInstruction(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processingInstruction</h4>
<pre><a href="../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a> processingInstruction(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> target)</pre>
<div class="block">DOCUMENT ME!</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - DOCUMENT ME!</dd>
<dt><span class="strong">Returns:</span></dt><dd>the processing instruction for the given target</dd></dl>
</li>
</ul>
<a name="setProcessingInstructions(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProcessingInstructions</h4>
<pre>void setProcessingInstructions(<a href="file:///usr/share/doc/default-jdk/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> listOfPIs)</pre>
<div class="block">Sets all the processing instructions for this branch</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listOfPIs</code> - DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="addElement(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addElement</h4>
<pre><a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> addElement(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block">Adds a new <code>Element</code> node with the given name to this branch
and returns a reference to the new node.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - is the name for the <code>Element</code> node.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the newly added <code>Element</code> node.</dd></dl>
</li>
</ul>
<a name="addElement(org.dom4j.QName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addElement</h4>
<pre><a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> addElement(<a href="../../org/dom4j/QName.html" title="class in org.dom4j">QName</a> qname)</pre>
<div class="block">Adds a new <code>Element</code> node with the given <a href="../../org/dom4j/QName.html" title="class in org.dom4j"><code>QName</code></a>to
this branch and returns a reference to the new node.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>qname</code> - is the qualified name for the <code>Element</code> node.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the newly added <code>Element</code> node.</dd></dl>
</li>
</ul>
<a name="addElement(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addElement</h4>
<pre><a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> addElement(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> qualifiedName,
<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespaceURI)</pre>
<div class="block">Adds a new <code>Element</code> node with the given qualified name and
namespace URI to this branch and returns a reference to the new node.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>qualifiedName</code> - is the fully qualified name of the Element</dd><dd><code>namespaceURI</code> - is the URI of the namespace to use</dd>
<dt><span class="strong">Returns:</span></dt><dd>the newly added <code>Element</code> node.</dd></dl>
</li>
</ul>
<a name="removeProcessingInstruction(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeProcessingInstruction</h4>
<pre>boolean removeProcessingInstruction(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> target)</pre>
<div class="block">Removes the processing instruction for the given target if it exists</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - DOCUMENT ME!</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if a processing instruction was removed else false</dd></dl>
</li>
</ul>
<a name="add(org.dom4j.Node)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>void add(<a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> node)</pre>
<div class="block">Adds the given <code>Node</code> or throws <a href="../../org/dom4j/IllegalAddException.html" title="class in org.dom4j"><code>IllegalAddException</code></a>
if the given node is not of a valid type. This is a polymorphic method
which will call the typesafe method for the node type such as
add(Element) or add(Comment).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>node</code> - is the given node to add</dd></dl>
</li>
</ul>
<a name="add(org.dom4j.Comment)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>void add(<a href="../../org/dom4j/Comment.html" title="interface in org.dom4j">Comment</a> comment)</pre>
<div class="block">Adds the given <code>Comment</code> to this branch. If the given node
already has a parent defined then an <code>IllegalAddException</code>
will be thrown.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comment</code> - is the comment to be added</dd></dl>
</li>
</ul>
<a name="add(org.dom4j.Element)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>void add(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> element)</pre>
<div class="block">Adds the given <code>Element</code> to this branch. If the given node
already has a parent defined then an <code>IllegalAddException</code>
will be thrown.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - is the element to be added</dd></dl>
</li>
</ul>
<a name="add(org.dom4j.ProcessingInstruction)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>void add(<a href="../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a> pi)</pre>
<div class="block">Adds the given <code>ProcessingInstruction</code> to this branch. If
the given node already has a parent defined then an
<code>IllegalAddException</code> will be thrown.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pi</code> - is the processing instruction to be added</dd></dl>
</li>
</ul>
<a name="remove(org.dom4j.Node)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>boolean remove(<a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> node)</pre>
<div class="block">Removes the given <code>Node</code> if the node is an immediate child
of this branch. If the given node is not an immediate child of this
branch then the <a href="../../org/dom4j/Node.html#detach()"><code>Node.detach()</code></a>method should be used instead. This
is a polymorphic method which will call the typesafe method for the node
type such as remove(Element) or remove(Comment).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>node</code> - is the given node to be removed</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the node was removed</dd></dl>
</li>
</ul>
<a name="remove(org.dom4j.Comment)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>boolean remove(<a href="../../org/dom4j/Comment.html" title="interface in org.dom4j">Comment</a> comment)</pre>
<div class="block">Removes the given <code>Comment</code> if the node is an immediate
child of this branch. If the given node is not an immediate child of this
branch then the <a href="../../org/dom4j/Node.html#detach()"><code>Node.detach()</code></a>method should be used instead.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comment</code> - is the comment to be removed</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the comment was removed</dd></dl>
</li>
</ul>
<a name="remove(org.dom4j.Element)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>boolean remove(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> element)</pre>
<div class="block">Removes the given <code>Element</code> if the node is an immediate
child of this branch. If the given node is not an immediate child of this
branch then the <a href="../../org/dom4j/Node.html#detach()"><code>Node.detach()</code></a>method should be used instead.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - is the element to be removed</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the element was removed</dd></dl>
</li>
</ul>
<a name="remove(org.dom4j.ProcessingInstruction)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>boolean remove(<a href="../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a> pi)</pre>
<div class="block">Removes the given <code>ProcessingInstruction</code> if the node is an
immediate child of this branch. If the given node is not an immediate
child of this branch then the <a href="../../org/dom4j/Node.html#detach()"><code>Node.detach()</code></a>method should be used
instead.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pi</code> - is the processing instruction to be removed</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the processing instruction was removed</dd></dl>
</li>
</ul>
<a name="normalize()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>normalize</h4>
<pre>void normalize()</pre>
<div class="block">Puts all <code>Text</code> nodes in the full depth of the sub-tree
underneath this <code>Node</code>, including attribute nodes, into a
"normal" form where only structure (e.g., elements, comments, processing
instructions, CDATA sections, and entity references) separates
<code>Text</code> nodes, i.e., there are neither adjacent
<code>Text</code> nodes nor empty <code>Text</code> nodes. This can
be used to ensure that the DOM view of a document is the same as if it
were saved and re-loaded, and is useful when operations (such as XPointer
lookups) that depend on a particular document tree structure are to be
used.In cases where the document contains <code>CDATASections</code>,
the normalize operation alone may not be sufficient, since XPointers do
not differentiate between <code>Text</code> nodes and
<code>CDATASection</code> nodes.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>DOM Level 2</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/Branch.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/dom4j/Attribute.html" title="interface in org.dom4j"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/dom4j/CDATA.html" title="interface in org.dom4j"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/dom4j/Branch.html" target="_top">Frames</a></li>
<li><a href="Branch.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 ? 2005 MetaStuff Ltd. All Rights Reserved. Hosted by <p> <img src='http://sourceforge.net/sflogo.php?group_id=16035' width='88' height='31' border='0' alt='SourceForge Logo' /></small></p>
</body>
</html>
|