/usr/share/doc/libjenkins-dom4j-java/api/org/dom4j/DocumentHelper.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 | <!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:38 UTC 2014 -->
<title>DocumentHelper (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="DocumentHelper (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/DocumentHelper.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/DocumentFactory.html" title="class in org.dom4j"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/dom4j/DocumentType.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/DocumentHelper.html" target="_top">Frames</a></li>
<li><a href="DocumentHelper.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="Class DocumentHelper" class="title">Class DocumentHelper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.dom4j.DocumentHelper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">DocumentHelper</span>
extends <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><p>
<code>DocumentHelper</code> is a collection of helper methods for using
DOM4J.
</p></div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.26 $</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">
<!-- ========== 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>static <a href="../../org/dom4j/Attribute.html" title="interface in org.dom4j">Attribute</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createAttribute(org.dom4j.Element,%20org.dom4j.QName,%20java.lang.String)">createAttribute</a></strong>(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> owner,
<a href="../../org/dom4j/QName.html" title="class in org.dom4j">QName</a> qname,
<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> value)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/Attribute.html" title="interface in org.dom4j">Attribute</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createAttribute(org.dom4j.Element,%20java.lang.String,%20java.lang.String)">createAttribute</a></strong>(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> owner,
<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,
<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> value)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/CDATA.html" title="interface in org.dom4j">CDATA</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createCDATA(java.lang.String)">createCDATA</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> text)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/Comment.html" title="interface in org.dom4j">Comment</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createComment(java.lang.String)">createComment</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> text)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createDocument()">createDocument</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createDocument(org.dom4j.Element)">createDocument</a></strong>(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> rootElement)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createElement(org.dom4j.QName)">createElement</a></strong>(<a href="../../org/dom4j/QName.html" title="class in org.dom4j">QName</a> qname)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createElement(java.lang.String)">createElement</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> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/Entity.html" title="interface in org.dom4j">Entity</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createEntity(java.lang.String,%20java.lang.String)">createEntity</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,
<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> text)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/Namespace.html" title="class in org.dom4j">Namespace</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createNamespace(java.lang.String,%20java.lang.String)">createNamespace</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> prefix,
<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> uri)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/rule/Pattern.html" title="interface in org.dom4j.rule">Pattern</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createPattern(java.lang.String)">createPattern</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> xpathPattern)</code>
<div class="block">
<code>createPattern</code> parses the given XPath expression to create
an XSLT style <a href="../../org/dom4j/rule/Pattern.html" title="interface in org.dom4j.rule"><code>Pattern</code></a>instance which can then be used in an XSLT
processing model.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createProcessingInstruction(java.lang.String,%20java.util.Map)">createProcessingInstruction</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> pi,
<a href="file:///usr/share/doc/default-jdk/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> data)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createProcessingInstruction(java.lang.String,%20java.lang.String)">createProcessingInstruction</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> pi,
<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> d)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/QName.html" title="class in org.dom4j">QName</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createQName(java.lang.String)">createQName</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> localName)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/QName.html" title="class in org.dom4j">QName</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createQName(java.lang.String,%20org.dom4j.Namespace)">createQName</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> localName,
<a href="../../org/dom4j/Namespace.html" title="class in org.dom4j">Namespace</a> namespace)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/Text.html" title="interface in org.dom4j">Text</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createText(java.lang.String)">createText</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> text)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/XPath.html" title="interface in org.dom4j">XPath</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createXPath(java.lang.String)">createXPath</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> xpathExpression)</code>
<div class="block">
<code>createXPath</code> parses an XPath expression and creates a new
XPath <code>XPath</code> instance using the singleton <a href="../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/XPath.html" title="interface in org.dom4j">XPath</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createXPath(java.lang.String,%20org.jaxen.VariableContext)">createXPath</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> xpathExpression,
org.jaxen.VariableContext context)</code>
<div class="block">
<code>createXPath</code> parses an XPath expression and creates a new
XPath <code>XPath</code> instance using the singleton <a href="../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/NodeFilter.html" title="interface in org.dom4j">NodeFilter</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#createXPathFilter(java.lang.String)">createXPathFilter</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> xpathFilterExpression)</code>
<div class="block">
<code>createXPathFilter</code> parses a NodeFilter from the given XPath
filter expression using the singleton <a href="../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#makeElement(org.dom4j.Branch,%20java.lang.String)">makeElement</a></strong>(<a href="../../org/dom4j/Branch.html" title="interface in org.dom4j">Branch</a> source,
<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> path)</code>
<div class="block">
makeElement</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#parseText(java.lang.String)">parseText</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> text)</code>
<div class="block">
<code>parseText</code> parses the given text as an XML document and
returns the newly created Document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/DocumentHelper.html#selectNodes(java.lang.String,%20java.util.List)">selectNodes</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> xpathFilterExpression,
<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> nodes)</code>
<div class="block">
<code>selectNodes</code> performs the given XPath expression on 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>of <a href="../../org/dom4j/Node.html" title="interface in org.dom4j"><code>Node</code></a>instances appending all the results together
into a single list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/DocumentHelper.html#selectNodes(java.lang.String,%20org.dom4j.Node)">selectNodes</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> xpathFilterExpression,
<a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> node)</code>
<div class="block">
<code>selectNodes</code> performs the given XPath expression on 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>of <a href="../../org/dom4j/Node.html" title="interface in org.dom4j"><code>Node</code></a>instances appending all the results together
into a single list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#sort(java.util.List,%20java.lang.String)">sort</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> list,
<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> xpathExpression)</code>
<div class="block">
<code>sort</code> sorts the given List of Nodes using an XPath
expression as a <a href="file:///usr/share/doc/default-jdk/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/DocumentHelper.html#sort(java.util.List,%20java.lang.String,%20boolean)">sort</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> list,
<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> expression,
boolean distinct)</code>
<div class="block">
<code>sort</code> sorts the given List of Nodes using an XPath
expression as a <a href="file:///usr/share/doc/default-jdk/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a>and optionally removing
duplicates.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</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="createDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDocument</h4>
<pre>public static <a href="../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> createDocument()</pre>
</li>
</ul>
<a name="createDocument(org.dom4j.Element)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDocument</h4>
<pre>public static <a href="../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> createDocument(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> rootElement)</pre>
</li>
</ul>
<a name="createElement(org.dom4j.QName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createElement</h4>
<pre>public static <a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> createElement(<a href="../../org/dom4j/QName.html" title="class in org.dom4j">QName</a> qname)</pre>
</li>
</ul>
<a name="createElement(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createElement</h4>
<pre>public static <a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> createElement(<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>
</li>
</ul>
<a name="createAttribute(org.dom4j.Element, org.dom4j.QName, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAttribute</h4>
<pre>public static <a href="../../org/dom4j/Attribute.html" title="interface in org.dom4j">Attribute</a> createAttribute(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> owner,
<a href="../../org/dom4j/QName.html" title="class in org.dom4j">QName</a> qname,
<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> value)</pre>
</li>
</ul>
<a name="createAttribute(org.dom4j.Element, java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAttribute</h4>
<pre>public static <a href="../../org/dom4j/Attribute.html" title="interface in org.dom4j">Attribute</a> createAttribute(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> owner,
<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,
<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> value)</pre>
</li>
</ul>
<a name="createCDATA(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createCDATA</h4>
<pre>public static <a href="../../org/dom4j/CDATA.html" title="interface in org.dom4j">CDATA</a> createCDATA(<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> text)</pre>
</li>
</ul>
<a name="createComment(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createComment</h4>
<pre>public static <a href="../../org/dom4j/Comment.html" title="interface in org.dom4j">Comment</a> createComment(<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> text)</pre>
</li>
</ul>
<a name="createText(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createText</h4>
<pre>public static <a href="../../org/dom4j/Text.html" title="interface in org.dom4j">Text</a> createText(<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> text)</pre>
</li>
</ul>
<a name="createEntity(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createEntity</h4>
<pre>public static <a href="../../org/dom4j/Entity.html" title="interface in org.dom4j">Entity</a> createEntity(<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,
<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> text)</pre>
</li>
</ul>
<a name="createNamespace(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createNamespace</h4>
<pre>public static <a href="../../org/dom4j/Namespace.html" title="class in org.dom4j">Namespace</a> createNamespace(<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> prefix,
<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> uri)</pre>
</li>
</ul>
<a name="createProcessingInstruction(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createProcessingInstruction</h4>
<pre>public static <a href="../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a> createProcessingInstruction(<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> pi,
<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> d)</pre>
</li>
</ul>
<a name="createProcessingInstruction(java.lang.String, java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createProcessingInstruction</h4>
<pre>public static <a href="../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a> createProcessingInstruction(<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> pi,
<a href="file:///usr/share/doc/default-jdk/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> data)</pre>
</li>
</ul>
<a name="createQName(java.lang.String, org.dom4j.Namespace)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQName</h4>
<pre>public static <a href="../../org/dom4j/QName.html" title="class in org.dom4j">QName</a> createQName(<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> localName,
<a href="../../org/dom4j/Namespace.html" title="class in org.dom4j">Namespace</a> namespace)</pre>
</li>
</ul>
<a name="createQName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQName</h4>
<pre>public static <a href="../../org/dom4j/QName.html" title="class in org.dom4j">QName</a> createQName(<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> localName)</pre>
</li>
</ul>
<a name="createXPath(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createXPath</h4>
<pre>public static <a href="../../org/dom4j/XPath.html" title="interface in org.dom4j">XPath</a> createXPath(<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> xpathExpression)
throws <a href="../../org/dom4j/InvalidXPathException.html" title="class in org.dom4j">InvalidXPathException</a></pre>
<div class="block"><p>
<code>createXPath</code> parses an XPath expression and creates a new
XPath <code>XPath</code> instance using the singleton <a href="../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathExpression</code> - is the XPath expression to create</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new <code>XPath</code> instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/dom4j/InvalidXPathException.html" title="class in org.dom4j">InvalidXPathException</a></code> - if the XPath expression is invalid</dd></dl>
</li>
</ul>
<a name="createXPath(java.lang.String, org.jaxen.VariableContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createXPath</h4>
<pre>public static <a href="../../org/dom4j/XPath.html" title="interface in org.dom4j">XPath</a> createXPath(<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> xpathExpression,
org.jaxen.VariableContext context)
throws <a href="../../org/dom4j/InvalidXPathException.html" title="class in org.dom4j">InvalidXPathException</a></pre>
<div class="block"><p>
<code>createXPath</code> parses an XPath expression and creates a new
XPath <code>XPath</code> instance using the singleton <a href="../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathExpression</code> - is the XPath expression to create</dd><dd><code>context</code> - is the variable context to use when evaluating the XPath</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new <code>XPath</code> instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/dom4j/InvalidXPathException.html" title="class in org.dom4j">InvalidXPathException</a></code> - if the XPath expression is invalid</dd></dl>
</li>
</ul>
<a name="createXPathFilter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createXPathFilter</h4>
<pre>public static <a href="../../org/dom4j/NodeFilter.html" title="interface in org.dom4j">NodeFilter</a> createXPathFilter(<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> xpathFilterExpression)</pre>
<div class="block"><p>
<code>createXPathFilter</code> parses a NodeFilter from the given XPath
filter expression using the singleton <a href="../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>. XPath
filter expressions occur within XPath expressions such as
<code>self::node()[ filterExpression ]</code>
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathFilterExpression</code> - is the XPath filter expression to create</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new <code>NodeFilter</code> instance</dd></dl>
</li>
</ul>
<a name="createPattern(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createPattern</h4>
<pre>public static <a href="../../org/dom4j/rule/Pattern.html" title="interface in org.dom4j.rule">Pattern</a> createPattern(<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> xpathPattern)</pre>
<div class="block"><p>
<code>createPattern</code> parses the given XPath expression to create
an XSLT style <a href="../../org/dom4j/rule/Pattern.html" title="interface in org.dom4j.rule"><code>Pattern</code></a>instance which can then be used in an XSLT
processing model.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathPattern</code> - is the XPath pattern expression to create</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new <code>Pattern</code> instance</dd></dl>
</li>
</ul>
<a name="selectNodes(java.lang.String, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNodes</h4>
<pre>public static <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> selectNodes(<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> xpathFilterExpression,
<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> nodes)</pre>
<div class="block"><p>
<code>selectNodes</code> performs the given XPath expression on 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>of <a href="../../org/dom4j/Node.html" title="interface in org.dom4j"><code>Node</code></a>instances appending all the results together
into a single list.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathFilterExpression</code> - is the XPath filter expression to evaluate</dd><dd><code>nodes</code> - is the list of nodes on which to evalute the XPath</dd>
<dt><span class="strong">Returns:</span></dt><dd>the results of all the XPath evaluations as a single list</dd></dl>
</li>
</ul>
<a name="selectNodes(java.lang.String, org.dom4j.Node)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNodes</h4>
<pre>public static <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> selectNodes(<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> xpathFilterExpression,
<a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> node)</pre>
<div class="block"><p>
<code>selectNodes</code> performs the given XPath expression on 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>of <a href="../../org/dom4j/Node.html" title="interface in org.dom4j"><code>Node</code></a>instances appending all the results together
into a single list.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathFilterExpression</code> - is the XPath filter expression to evaluate</dd><dd><code>node</code> - is the Node on which to evalute the XPath</dd>
<dt><span class="strong">Returns:</span></dt><dd>the results of all the XPath evaluations as a single list</dd></dl>
</li>
</ul>
<a name="sort(java.util.List, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sort</h4>
<pre>public static void sort(<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> list,
<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> xpathExpression)</pre>
<div class="block"><p>
<code>sort</code> sorts the given List of Nodes using an XPath
expression as a <a href="file:///usr/share/doc/default-jdk/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list</code> - is the list of Nodes to sort</dd><dd><code>xpathExpression</code> - is the XPath expression used for comparison</dd></dl>
</li>
</ul>
<a name="sort(java.util.List, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sort</h4>
<pre>public static void sort(<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> list,
<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> expression,
boolean distinct)</pre>
<div class="block"><p>
<code>sort</code> sorts the given List of Nodes using an XPath
expression as a <a href="file:///usr/share/doc/default-jdk/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a>and optionally removing
duplicates.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list</code> - is the list of Nodes to sort</dd><dd><code>expression</code> - is the XPath expression used for comparison</dd><dd><code>distinct</code> - if true then duplicate values (using the sortXPath for
comparisions) will be removed from the List</dd></dl>
</li>
</ul>
<a name="parseText(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseText</h4>
<pre>public static <a href="../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> parseText(<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> text)
throws <a href="../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block"><p>
<code>parseText</code> parses the given text as an XML document and
returns the newly created Document.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - the XML text to be parsed</dd>
<dt><span class="strong">Returns:</span></dt><dd>a newly parsed Document</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></code> - if the document could not be parsed</dd></dl>
</li>
</ul>
<a name="makeElement(org.dom4j.Branch, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>makeElement</h4>
<pre>public static <a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> makeElement(<a href="../../org/dom4j/Branch.html" title="interface in org.dom4j">Branch</a> source,
<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> path)</pre>
<div class="block"><p>
makeElement
</p>
a helper method which navigates from the given Document or Element node
to some Element using the path expression, creating any necessary
elements along the way. For example the path <code>a/b/c</code> would
get the first child <a> element, which would be created if it did
not exist, then the next child <b> and so on until finally a
<c> element is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - is the Element or Document to start navigating from</dd><dd><code>path</code> - is a simple path expression, seperated by '/' which denotes
the path from the source to the resulting element such as
a/b/c</dd>
<dt><span class="strong">Returns:</span></dt><dd>the first Element on the given path which either already existed
on the path or were created by this method.</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/DocumentHelper.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/DocumentFactory.html" title="class in org.dom4j"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/dom4j/DocumentType.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/DocumentHelper.html" target="_top">Frames</a></li>
<li><a href="DocumentHelper.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>
|