/usr/share/doc/libjdom1-java/api/org/jdom/Document.html is in libjdom1-java-doc 1.1.3-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 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 | <!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_25) on Mon Oct 21 14:11:49 UTC 2013 -->
<title>Document (JDOM v1.SNAPSHOT)</title>
<meta name="date" content="2013-10-21">
<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="Document (JDOM v1.SNAPSHOT)";
}
//-->
</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/Document.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'>1.SNAPSHOT</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/jdom/DocType.html" title="class in org.jdom"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/jdom/Element.html" title="class in org.jdom"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jdom/Document.html" target="_top">Frames</a></li>
<li><a href="Document.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><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.jdom</div>
<h2 title="Class Document" class="title">Class Document</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.jdom.Document</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Cloneable, <a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Document</span>
extends java.lang.Object
implements <a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></pre>
<div class="block">An XML document. Methods allow access to the root element as well as the
<a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a> and other document-level information.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.85 $, $Date: 2007/11/10 05:28:58 $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Brett McLaughlin, Jason Hunter, Jools Enticknap, Bradley S. Huffman</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../serialized-form.html#org.jdom.Document">Serialized Form</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>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#baseURI">baseURI</a></strong></code>
<div class="block">See http://www.w3.org/TR/2003/WD-DOM-Level-3-Core-20030226/core.html#baseURIs-Considerations</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../org/jdom/Document.html#Document()">Document</a></strong>()</code>
<div class="block">Creates a new empty document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../org/jdom/Document.html#Document(org.jdom.Element)">Document</a></strong>(<a href="../../org/jdom/Element.html" title="class in org.jdom">Element</a> rootElement)</code>
<div class="block">This will create a new <code>Document</code>,
with the supplied <code><a href="../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a></code>
as the root element, and no <code><a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a></code>
declaration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../org/jdom/Document.html#Document(org.jdom.Element, org.jdom.DocType)">Document</a></strong>(<a href="../../org/jdom/Element.html" title="class in org.jdom">Element</a> rootElement,
<a href="../../org/jdom/DocType.html" title="class in org.jdom">DocType</a> docType)</code>
<div class="block">This will create a new <code>Document</code>,
with the supplied <code><a href="../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a></code>
as the root element and the supplied
<code><a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a></code> declaration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../org/jdom/Document.html#Document(org.jdom.Element, org.jdom.DocType, java.lang.String)">Document</a></strong>(<a href="../../org/jdom/Element.html" title="class in org.jdom">Element</a> rootElement,
<a href="../../org/jdom/DocType.html" title="class in org.jdom">DocType</a> docType,
java.lang.String baseURI)</code>
<div class="block">This will create a new <code>Document</code>,
with the supplied <code><a href="../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a></code>
as the root element, the supplied
<code><a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a></code> declaration, and the specified
base URI.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../org/jdom/Document.html#Document(java.util.List)">Document</a></strong>(java.util.List content)</code>
<div class="block">This will create a new <code>Document</code>,
with the supplied list of content, and a
<code><a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a></code> declaration only if the content
contains a DocType instance.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#addContent(java.util.Collection)">addContent</a></strong>(java.util.Collection 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/jdom/Document.html" title="class in org.jdom">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#addContent(org.jdom.Content)">addContent</a></strong>(<a href="../../org/jdom/Content.html" title="class in org.jdom">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/jdom/Document.html" title="class in org.jdom">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#addContent(int, java.util.Collection)">addContent</a></strong>(int index,
java.util.Collection 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/jdom/Document.html" title="class in org.jdom">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#addContent(int, org.jdom.Content)">addContent</a></strong>(int index,
<a href="../../org/jdom/Content.html" title="class in org.jdom">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>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#clone()">clone</a></strong>()</code>
<div class="block">This will return a deep clone of this <code>Document</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.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="altColor">
<td class="colFirst"><code><a href="../../org/jdom/Element.html" title="class in org.jdom">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#detachRootElement()">detachRootElement</a></strong>()</code>
<div class="block">Detach the root <code><a href="../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a></code> from this document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object ob)</code>
<div class="block">This tests for equality of this <code>Document</code> to the supplied
<code>Object</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#getBaseURI()">getBaseURI</a></strong>()</code>
<div class="block">
Returns the URI from which this document was loaded,
or null if this is not known.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#getContent()">getContent</a></strong>()</code>
<div class="block">This will return all content for the <code>Document</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#getContent(org.jdom.filter.Filter)">getContent</a></strong>(<a href="../../org/jdom/filter/Filter.html" title="interface in org.jdom.filter">Filter</a> filter)</code>
<div class="block">Return a filtered view of this <code>Document</code>'s content.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/jdom/Content.html" title="class in org.jdom">Content</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.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/jdom/Document.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>java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#getDescendants()">getDescendants</a></strong>()</code>
<div class="block">Returns an iterator that walks over all descendants in document order.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#getDescendants(org.jdom.filter.Filter)">getDescendants</a></strong>(<a href="../../org/jdom/filter/Filter.html" title="interface in org.jdom.filter">Filter</a> filter)</code>
<div class="block">Returns an iterator that walks over all descendants in document order
applying the Filter to return only elements that match the filter rule.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/jdom/DocType.html" title="class in org.jdom">DocType</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#getDocType()">getDocType</a></strong>()</code>
<div class="block">This will return the <code><a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a></code>
declaration for this <code>Document</code>, or
<code>null</code> if none exists.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.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="rowColor">
<td class="colFirst"><code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.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="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#getProperty(java.lang.String)">getProperty</a></strong>(java.lang.String id)</code>
<div class="block">Returns the object associated with this document under the given "id"
string, or null if there is no binding or if the binding explicitly
stored a null value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/jdom/Element.html" title="class in org.jdom">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#getRootElement()">getRootElement</a></strong>()</code>
<div class="block">This will return the root <code>Element</code>
for this <code>Document</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">This returns the hash code for this <code>Document</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#hasRootElement()">hasRootElement</a></strong>()</code>
<div class="block">This will return <code>true</code> if this document has a
root element, <code>false</code> otherwise.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#indexOf(org.jdom.Content)">indexOf</a></strong>(<a href="../../org/jdom/Content.html" title="class in org.jdom">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="rowColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#removeContent()">removeContent</a></strong>()</code>
<div class="block">Removes all child content from this parent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#removeContent(org.jdom.Content)">removeContent</a></strong>(<a href="../../org/jdom/Content.html" title="class in org.jdom">Content</a> child)</code>
<div class="block">Removes a single child node from the content list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#removeContent(org.jdom.filter.Filter)">removeContent</a></strong>(<a href="../../org/jdom/filter/Filter.html" title="interface in org.jdom.filter">Filter</a> filter)</code>
<div class="block">Remove all child content from this parent matching the supplied filter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/jdom/Content.html" title="class in org.jdom">Content</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.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>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#setBaseURI(java.lang.String)">setBaseURI</a></strong>(java.lang.String uri)</code>
<div class="block">
Sets the effective URI from which this document was loaded,
and against which relative URLs in this document will be resolved.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#setContent(java.util.Collection)">setContent</a></strong>(java.util.Collection newContent)</code>
<div class="block">This sets the content of the <code>Document</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#setContent(org.jdom.Content)">setContent</a></strong>(<a href="../../org/jdom/Content.html" title="class in org.jdom">Content</a> child)</code>
<div class="block">Set this document's content to be the supplied child.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#setContent(int, java.util.Collection)">setContent</a></strong>(int index,
java.util.Collection collection)</code>
<div class="block">Replace the child at the given index whith the supplied
collection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#setContent(int, org.jdom.Content)">setContent</a></strong>(int index,
<a href="../../org/jdom/Content.html" title="class in org.jdom">Content</a> child)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#setDocType(org.jdom.DocType)">setDocType</a></strong>(<a href="../../org/jdom/DocType.html" title="class in org.jdom">DocType</a> docType)</code>
<div class="block">This will set the <code><a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a></code>
declaration for this <code>Document</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#setProperty(java.lang.String, java.lang.Object)">setProperty</a></strong>(java.lang.String id,
java.lang.Object value)</code>
<div class="block">Assigns an arbitrary object to be associated with this document under
the given "id" string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#setRootElement(org.jdom.Element)">setRootElement</a></strong>(<a href="../../org/jdom/Element.html" title="class in org.jdom">Element</a> rootElement)</code>
<div class="block">This sets the root <code><a href="../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a></code> for the
<code>Document</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/jdom/Document.html#toString()">toString</a></strong>()</code>
<div class="block">This returns a <code>String</code> representation of the
<code>Document</code>, suitable for debugging.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="baseURI">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>baseURI</h4>
<pre>protected java.lang.String baseURI</pre>
<div class="block">See http://www.w3.org/TR/2003/WD-DOM-Level-3-Core-20030226/core.html#baseURIs-Considerations</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Document()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Document</h4>
<pre>public Document()</pre>
<div class="block">Creates a new empty document. A document must have a root element,
so this document will not be well-formed and accessor methods will
throw an IllegalStateException if this document is accessed before a
root element is added. This method is most useful for build tools.</div>
</li>
</ul>
<a name="Document(org.jdom.Element, org.jdom.DocType, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Document</h4>
<pre>public Document(<a href="../../org/jdom/Element.html" title="class in org.jdom">Element</a> rootElement,
<a href="../../org/jdom/DocType.html" title="class in org.jdom">DocType</a> docType,
java.lang.String baseURI)</pre>
<div class="block">This will create a new <code>Document</code>,
with the supplied <code><a href="../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a></code>
as the root element, the supplied
<code><a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a></code> declaration, and the specified
base URI.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootElement</code> - <code>Element</code> for document root.</dd><dd><code>docType</code> - <code>DocType</code> declaration.</dd><dd><code>baseURI</code> - the URI from which this doucment was loaded.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/jdom/IllegalAddException.html" title="class in org.jdom">IllegalAddException</a></code> - if the given docType object
is already attached to a document or the given
rootElement already has a parent</dd></dl>
</li>
</ul>
<a name="Document(org.jdom.Element, org.jdom.DocType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Document</h4>
<pre>public Document(<a href="../../org/jdom/Element.html" title="class in org.jdom">Element</a> rootElement,
<a href="../../org/jdom/DocType.html" title="class in org.jdom">DocType</a> docType)</pre>
<div class="block">This will create a new <code>Document</code>,
with the supplied <code><a href="../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a></code>
as the root element and the supplied
<code><a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a></code> declaration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootElement</code> - <code>Element</code> for document root.</dd><dd><code>docType</code> - <code>DocType</code> declaration.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/jdom/IllegalAddException.html" title="class in org.jdom">IllegalAddException</a></code> - if the given DocType object
is already attached to a document or the given
rootElement already has a parent</dd></dl>
</li>
</ul>
<a name="Document(org.jdom.Element)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Document</h4>
<pre>public Document(<a href="../../org/jdom/Element.html" title="class in org.jdom">Element</a> rootElement)</pre>
<div class="block">This will create a new <code>Document</code>,
with the supplied <code><a href="../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a></code>
as the root element, and no <code><a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a></code>
declaration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootElement</code> - <code>Element</code> for document root</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/jdom/IllegalAddException.html" title="class in org.jdom">IllegalAddException</a></code> - if the given rootElement already has
a parent.</dd></dl>
</li>
</ul>
<a name="Document(java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Document</h4>
<pre>public Document(java.util.List content)</pre>
<div class="block">This will create a new <code>Document</code>,
with the supplied list of content, and a
<code><a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a></code> declaration only if the content
contains a DocType instance. A null list is treated the
same as the no-arg constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - <code>List</code> of starter content</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/jdom/IllegalAddException.html" title="class in org.jdom">IllegalAddException</a></code> - if the List contains more than
one Element or objects of illegal types.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getContentSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentSize</h4>
<pre>public int getContentSize()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../org/jdom/Parent.html#getContentSize()">Parent</a></code></strong></div>
<div class="block">Returns the number of children in this parent's content list.
Children may be any <a href="../../org/jdom/Content.html" title="class in org.jdom"><code>Content</code></a> type.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#getContentSize()">getContentSize</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>number of children</dd></dl>
</li>
</ul>
<a name="indexOf(org.jdom.Content)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexOf</h4>
<pre>public int indexOf(<a href="../../org/jdom/Content.html" title="class in org.jdom">Content</a> child)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../org/jdom/Parent.html#indexOf(org.jdom.Content)">Parent</a></code></strong></div>
<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><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#indexOf(org.jdom.Content)">indexOf</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<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="hasRootElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasRootElement</h4>
<pre>public boolean hasRootElement()</pre>
<div class="block">This will return <code>true</code> if this document has a
root element, <code>false</code> otherwise.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this document has a root element,
<code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="getRootElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRootElement</h4>
<pre>public <a href="../../org/jdom/Element.html" title="class in org.jdom">Element</a> getRootElement()</pre>
<div class="block">This will return the root <code>Element</code>
for this <code>Document</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>Element</code> - the document's root element</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the root element hasn't been set</dd></dl>
</li>
</ul>
<a name="setRootElement(org.jdom.Element)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRootElement</h4>
<pre>public <a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a> setRootElement(<a href="../../org/jdom/Element.html" title="class in org.jdom">Element</a> rootElement)</pre>
<div class="block">This sets the root <code><a href="../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a></code> for the
<code>Document</code>. If the document already has a root
element, it is replaced.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootElement</code> - <code>Element</code> to be new root.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>Document</code> - modified Document.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/jdom/IllegalAddException.html" title="class in org.jdom">IllegalAddException</a></code> - if the given rootElement already has
a parent.</dd></dl>
</li>
</ul>
<a name="detachRootElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detachRootElement</h4>
<pre>public <a href="../../org/jdom/Element.html" title="class in org.jdom">Element</a> detachRootElement()</pre>
<div class="block">Detach the root <code><a href="../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a></code> from this document.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>removed root <code>Element</code></dd></dl>
</li>
</ul>
<a name="getDocType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocType</h4>
<pre>public <a href="../../org/jdom/DocType.html" title="class in org.jdom">DocType</a> getDocType()</pre>
<div class="block">This will return the <code><a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a></code>
declaration for this <code>Document</code>, or
<code>null</code> if none exists.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>DocType</code> - the DOCTYPE declaration.</dd></dl>
</li>
</ul>
<a name="setDocType(org.jdom.DocType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDocType</h4>
<pre>public <a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a> setDocType(<a href="../../org/jdom/DocType.html" title="class in org.jdom">DocType</a> docType)</pre>
<div class="block">This will set the <code><a href="../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a></code>
declaration for this <code>Document</code>. Note
that a DocType can only be attached to one Document.
Attempting to set the DocType to a DocType object
that already belongs to a Document will result in an
IllegalAddException being thrown.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>docType</code> - <code>DocType</code> declaration.</dd>
<dt><span class="strong">Returns:</span></dt><dd>object on which the method was invoked</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/jdom/IllegalAddException.html" title="class in org.jdom">IllegalAddException</a></code> - if the given docType is
already attached to a Document.</dd></dl>
</li>
</ul>
<a name="addContent(org.jdom.Content)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addContent</h4>
<pre>public <a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a> addContent(<a href="../../org/jdom/Content.html" title="class in org.jdom">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 document on which the method was called</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/jdom/IllegalAddException.html" title="class in org.jdom">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>public <a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a> addContent(java.util.Collection 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/jdom/IllegalAddException.html" title="class in org.jdom">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.jdom.Content)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addContent</h4>
<pre>public <a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a> addContent(int index,
<a href="../../org/jdom/Content.html" title="class in org.jdom">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/jdom/IllegalAddException.html" title="class in org.jdom">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="blockList">
<li class="blockList">
<h4>addContent</h4>
<pre>public <a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a> addContent(int index,
java.util.Collection 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/jdom/IllegalAddException.html" title="class in org.jdom">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="cloneContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneContent</h4>
<pre>public java.util.List cloneContent()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../org/jdom/Parent.html#cloneContent()">Parent</a></code></strong></div>
<div class="block">Returns a list containing detached clones of this parent's content list.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#cloneContent()">cloneContent</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<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>public <a href="../../org/jdom/Content.html" title="class in org.jdom">Content</a> getContent(int index)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../org/jdom/Parent.html#getContent(int)">Parent</a></code></strong></div>
<div class="block">Returns the child at the given index.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#getContent(int)">getContent</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<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></dl>
</li>
</ul>
<a name="getContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContent</h4>
<pre>public java.util.List getContent()</pre>
<div class="block">This will return all content for the <code>Document</code>.
The returned list is "live" in document order and changes to it
affect the document's actual content.
<p>
Sequential traversal through the List is best done with a Iterator
since the underlying implement of List.size() may require walking the
entire list.
</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#getContent()">getContent</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>List</code> - all Document content</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the root element hasn't been set</dd></dl>
</li>
</ul>
<a name="getContent(org.jdom.filter.Filter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContent</h4>
<pre>public java.util.List getContent(<a href="../../org/jdom/filter/Filter.html" title="interface in org.jdom.filter">Filter</a> filter)</pre>
<div class="block">Return a filtered view of this <code>Document</code>'s content.
<p>
Sequential traversal through the List is best done with a Iterator
since the underlying implement of List.size() may require walking the
entire list.
</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#getContent(org.jdom.filter.Filter)">getContent</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - <code>Filter</code> to apply</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>List</code> - filtered Document content</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the root element hasn't been set</dd></dl>
</li>
</ul>
<a name="removeContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeContent</h4>
<pre>public java.util.List removeContent()</pre>
<div class="block">Removes all child content from this parent.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#removeContent()">removeContent</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>list of the old children detached from this parent</dd></dl>
</li>
</ul>
<a name="removeContent(org.jdom.filter.Filter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeContent</h4>
<pre>public java.util.List removeContent(<a href="../../org/jdom/filter/Filter.html" title="interface in org.jdom.filter">Filter</a> filter)</pre>
<div class="block">Remove all child content from this parent matching the supplied filter.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#removeContent(org.jdom.filter.Filter)">removeContent</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - filter to select which content to remove</dd>
<dt><span class="strong">Returns:</span></dt><dd>list of the old children detached from this parent</dd></dl>
</li>
</ul>
<a name="setContent(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContent</h4>
<pre>public <a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a> setContent(java.util.Collection newContent)</pre>
<div class="block">This sets the content of the <code>Document</code>. The supplied
List should contain only objects of type <code>Element</code>,
<code>Comment</code>, and <code>ProcessingInstruction</code>.
<p>
When all objects in the supplied List are legal and before the new
content is added, all objects in the old content will have their
parentage set to null (no parent) and the old content list will be
cleared. This has the effect that any active list (previously obtained
with a call to <a href="../../org/jdom/Document.html#getContent(int)"><code>getContent(int)</code></a>) will also
change to reflect the new content. In addition, all objects in the
supplied List will have their parentage set to this document, but the
List itself will not be "live" and further removals and additions will
have no effect on this document content. If the user wants to continue
working with a "live" list, then a call to setContent should be
followed by a call to <a href="../../org/jdom/Document.html#getContent(int)"><code>getContent(int)</code></a> to
obtain a "live" version of the content.
</p>
<p>
Passing a null or empty List clears the existing content.
</p>
<p>
In event of an exception the original content will be unchanged and
the objects in the supplied content will be unaltered.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newContent</code> - <code>List</code> of content to set</dd>
<dt><span class="strong">Returns:</span></dt><dd>this document modified</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/jdom/IllegalAddException.html" title="class in org.jdom">IllegalAddException</a></code> - if the List contains objects of
illegal types or with existing parentage.</dd></dl>
</li>
</ul>
<a name="setBaseURI(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBaseURI</h4>
<pre>public final void setBaseURI(java.lang.String uri)</pre>
<div class="block"><p>
Sets the effective URI from which this document was loaded,
and against which relative URLs in this document will be resolved.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uri</code> - the base URI of this document</dd></dl>
</li>
</ul>
<a name="getBaseURI()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBaseURI</h4>
<pre>public final java.lang.String getBaseURI()</pre>
<div class="block"><p>
Returns the URI from which this document was loaded,
or null if this is not known.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the base URI of this document</dd></dl>
</li>
</ul>
<a name="setContent(int, org.jdom.Content)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContent</h4>
<pre>public <a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a> setContent(int index,
<a href="../../org/jdom/Content.html" title="class in org.jdom">Content</a> child)</pre>
</li>
</ul>
<a name="setContent(int, java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContent</h4>
<pre>public <a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a> setContent(int index,
java.util.Collection collection)</pre>
<div class="block">Replace the child at the given index whith the supplied
collection.
<p>
In event of an exception the original content will be unchanged and
the content in the supplied collection will be unaltered.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - index of child to replace.</dd><dd><code>collection</code> - - collection of content to add.</dd>
<dt><span class="strong">Returns:</span></dt><dd>object on which the method was invoked</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/jdom/IllegalAddException.html" title="class in org.jdom">IllegalAddException</a></code> - if the collection contains objects of
illegal types.</dd>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if index is negative or greater
than the current number of children.</dd></dl>
</li>
</ul>
<a name="removeContent(org.jdom.Content)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeContent</h4>
<pre>public boolean removeContent(<a href="../../org/jdom/Content.html" title="class in org.jdom">Content</a> child)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../org/jdom/Parent.html#removeContent(org.jdom.Content)">Parent</a></code></strong></div>
<div class="block">Removes a single child node from the content list.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#removeContent(org.jdom.Content)">removeContent</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<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>public <a href="../../org/jdom/Content.html" title="class in org.jdom">Content</a> removeContent(int index)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../org/jdom/Parent.html#removeContent(int)">Parent</a></code></strong></div>
<div class="block">Removes and returns the child at the given
index, or returns null if there's no such child.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#removeContent(int)">removeContent</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<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></dl>
</li>
</ul>
<a name="setContent(org.jdom.Content)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContent</h4>
<pre>public <a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a> setContent(<a href="../../org/jdom/Content.html" title="class in org.jdom">Content</a> child)</pre>
<div class="block">Set this document's content to be the supplied child.
<p>
If the supplied child is legal content for a Document and before
it is added, all content in the current content list will
be cleared and all current children will have their parentage set to
null.
<p>
This has the effect that any active list (previously obtained with
a call to one of the <a href="../../org/jdom/Document.html#getContent(int)"><code>getContent(int)</code></a> methods will also change
to reflect the new content. In addition, all content in the supplied
collection will have their parentage set to this Document. If the user
wants to continue working with a <b>"live"</b> list of this Document's
child, then a call to setContent should be followed by a call to one
of the <a href="../../org/jdom/Document.html#getContent(int)"><code>getContent(int)</code></a> methods to obtain a <b>"live"</b>
version of the children.
<p>
Passing a null child clears the existing content.
<p>
In event of an exception the original content will be unchanged and
the supplied child will be unaltered.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>child</code> - new content to replace existing content</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><a href="../../org/jdom/IllegalAddException.html" title="class in org.jdom">IllegalAddException</a></code> - if the supplied child is already attached
or not legal content for this parent</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">This returns a <code>String</code> representation of the
<code>Document</code>, suitable for debugging. If the XML
representation of the <code>Document</code> is desired,
<a href="../../org/jdom/output/XMLOutputter.html#outputString(org.jdom.Document)"><code>XMLOutputter.outputString(Document)</code></a>
should be used.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>String</code> - information about the
<code>Document</code></dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public final boolean equals(java.lang.Object ob)</pre>
<div class="block">This tests for equality of this <code>Document</code> to the supplied
<code>Object</code>.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>ob</code> - <code>Object</code> to compare to</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>boolean</code> whether the <code>Document</code> is
equal to the supplied <code>Object</code></dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public final int hashCode()</pre>
<div class="block">This returns the hash code for this <code>Document</code>.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>int</code> hash code</dd></dl>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public java.lang.Object clone()</pre>
<div class="block">This will return a deep clone of this <code>Document</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#clone()">clone</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>clone</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>Object</code> clone of this <code>Document</code></dd></dl>
</li>
</ul>
<a name="getDescendants()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescendants</h4>
<pre>public java.util.Iterator getDescendants()</pre>
<div class="block">Returns an iterator that walks over all descendants in document order.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#getDescendants()">getDescendants</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an iterator to walk descendants</dd></dl>
</li>
</ul>
<a name="getDescendants(org.jdom.filter.Filter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescendants</h4>
<pre>public java.util.Iterator getDescendants(<a href="../../org/jdom/filter/Filter.html" title="interface in org.jdom.filter">Filter</a> filter)</pre>
<div class="block">Returns an iterator that walks over all descendants in document order
applying the Filter to return only elements 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.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#getDescendants(org.jdom.filter.Filter)">getDescendants</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></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 within a filter</dd></dl>
</li>
</ul>
<a name="getParent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre>public <a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a> getParent()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../org/jdom/Parent.html#getParent()">Parent</a></code></strong></div>
<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><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#getParent()">getParent</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<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>public <a href="../../org/jdom/Document.html" title="class in org.jdom">Document</a> getDocument()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../org/jdom/Parent.html#getDocument()">Parent</a></code></strong></div>
<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><strong>Specified by:</strong></dt>
<dd><code><a href="../../org/jdom/Parent.html#getDocument()">getDocument</a></code> in interface <code><a href="../../org/jdom/Parent.html" title="interface in org.jdom">Parent</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>this child's owning document or null if none</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../org/jdom/Parent.html#getDocument()"><code>Parent.getDocument()</code></a></dd></dl>
</li>
</ul>
<a name="setProperty(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>public void setProperty(java.lang.String id,
java.lang.Object value)</pre>
<div class="block">Assigns an arbitrary object to be associated with this document under
the given "id" string. Null values are permitted. Strings beginning
with "http://www.jdom.org/ are reserved for JDOM use.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - the id of the stored object</dd><dd><code>value</code> - the object to store</dd></dl>
</li>
</ul>
<a name="getProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getProperty</h4>
<pre>public java.lang.Object getProperty(java.lang.String id)</pre>
<div class="block">Returns the object associated with this document under the given "id"
string, or null if there is no binding or if the binding explicitly
stored a null value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - the id of the stored object to return</dd>
<dt><span class="strong">Returns:</span></dt><dd>the object associated with the given id</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/Document.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'>1.SNAPSHOT</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/jdom/DocType.html" title="class in org.jdom"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/jdom/Element.html" title="class in org.jdom"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jdom/Document.html" target="_top">Frames</a></li>
<li><a href="Document.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><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright ? 2011 Jason Hunter, Brett McLaughlin. All Rights Reserved.</small></p>
</body>
</html>
|