/usr/share/doc/libjdom1-java/api/org/jdom/input/SAXBuilder.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 | <!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.6.0_27) on Tue Jul 30 04:06:34 UTC 2013 -->
<title>SAXBuilder (JDOM v1.SNAPSHOT)</title>
<meta name="date" content="2013-07-30">
<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="SAXBuilder (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/SAXBuilder.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/input/JDOMParseException.html" title="class in org.jdom.input"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../org/jdom/input/SAXHandler.html" title="class in org.jdom.input"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom/input/SAXBuilder.html" target="_top">FRAMES</a></li>
<li><a href="SAXBuilder.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><a href="#constructor_summary">CONSTR</a> | </li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL: </li>
<li>FIELD | </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">
<p class="subTitle">org.jdom.input</p>
<h2 title="Class SAXBuilder" class="title">Class SAXBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.jdom.input.SAXBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <strong>SAXBuilder</strong>
extends java.lang.Object</pre>
<div class="block">Builds a JDOM document from files, streams, readers, URLs, or a SAX <code>InputSource</code> instance using a SAX parser. The builder uses a
third-party SAX parser (chosen by JAXP by default, or you can choose
manually) to handle the parsing duties and simply listens to the SAX events
to construct a document. Details which SAX does not provide, such as
whitespace outside the root element, are not represented in the JDOM
document. Information about SAX can be found at <a
href="http://www.saxproject.org">http://www.saxproject.org</a>.
<p>
Known issues: Relative paths for a <a href="../../../org/jdom/DocType.html" title="class in org.jdom"><code>DocType</code></a> or <a href="../../../org/jdom/EntityRef.html" title="class in org.jdom"><code>EntityRef</code></a> may
be converted by the SAX parser into absolute paths.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.93 $, $Date: 2009/07/23 06:26:26 $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Jason Hunter, Brett McLaughlin, Dan Schaffer, Philip Nelson, Alex Rosen</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/input/SAXBuilder.html#SAXBuilder()">SAXBuilder</a></strong>()</code>
<div class="block">Creates a new SAXBuilder which will attempt to first locate
a parser via JAXP, then will try to use a set of default
SAX Drivers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#SAXBuilder(boolean)">SAXBuilder</a></strong>(boolean validate)</code>
<div class="block">Creates a new SAXBuilder which will attempt to first locate
a parser via JAXP, then will try to use a set of default
SAX Drivers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#SAXBuilder(java.lang.String)">SAXBuilder</a></strong>(java.lang.String saxDriverClass)</code>
<div class="block">Creates a new SAXBuilder using the specified SAX parser.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#SAXBuilder(java.lang.String, boolean)">SAXBuilder</a></strong>(java.lang.String saxDriverClass,
boolean validate)</code>
<div class="block">Creates a new SAXBuilder using the specified SAX parser.</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/input/SAXBuilder.html#build(java.io.File)">build</a></strong>(java.io.File file)</code>
<div class="block">
This builds a document from the supplied
filename.</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/input/SAXBuilder.html#build(org.xml.sax.InputSource)">build</a></strong>(org.xml.sax.InputSource in)</code>
<div class="block">This builds a document from the supplied
input source.</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/input/SAXBuilder.html#build(java.io.InputStream)">build</a></strong>(java.io.InputStream in)</code>
<div class="block">
This builds a document from the supplied
input stream.</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/input/SAXBuilder.html#build(java.io.InputStream, java.lang.String)">build</a></strong>(java.io.InputStream in,
java.lang.String systemId)</code>
<div class="block">
This builds a document from the supplied
input stream.</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/input/SAXBuilder.html#build(java.io.Reader)">build</a></strong>(java.io.Reader characterStream)</code>
<div class="block">
This builds a document from the supplied
Reader.</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/input/SAXBuilder.html#build(java.io.Reader, java.lang.String)">build</a></strong>(java.io.Reader characterStream,
java.lang.String systemId)</code>
<div class="block">
This builds a document from the supplied
Reader.</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/input/SAXBuilder.html#build(java.lang.String)">build</a></strong>(java.lang.String systemId)</code>
<div class="block">
This builds a document from the supplied
URI.</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/input/SAXBuilder.html#build(java.net.URL)">build</a></strong>(java.net.URL url)</code>
<div class="block">
This builds a document from the supplied
URL.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#configureContentHandler(org.jdom.input.SAXHandler)">configureContentHandler</a></strong>(<a href="../../../org/jdom/input/SAXHandler.html" title="class in org.jdom.input">SAXHandler</a> contentHandler)</code>
<div class="block">This configures the SAXHandler that will be used to build the Document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#configureParser(org.xml.sax.XMLReader, org.jdom.input.SAXHandler)">configureParser</a></strong>(org.xml.sax.XMLReader parser,
<a href="../../../org/jdom/input/SAXHandler.html" title="class in org.jdom.input">SAXHandler</a> contentHandler)</code>
<div class="block">This configures the XMLReader to be used for reading the XML document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../org/jdom/input/SAXHandler.html" title="class in org.jdom.input">SAXHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#createContentHandler()">createContentHandler</a></strong>()</code>
<div class="block">This creates the SAXHandler that will be used to build the Document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.xml.sax.XMLReader</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#createParser()">createParser</a></strong>()</code>
<div class="block">This creates the XMLReader to be used for reading the XML document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#getDriverClass()">getDriverClass</a></strong>()</code>
<div class="block">Returns the driver class assigned in the constructor, or null if none.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.xml.sax.DTDHandler</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#getDTDHandler()">getDTDHandler</a></strong>()</code>
<div class="block">Returns the <code>DTDHandler</code> assigned, or null if none.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.xml.sax.EntityResolver</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#getEntityResolver()">getEntityResolver</a></strong>()</code>
<div class="block">Returns the <code>EntityResolver</code> assigned, or null if none.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.xml.sax.ErrorHandler</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#getErrorHandler()">getErrorHandler</a></strong>()</code>
<div class="block">Returns the <code>ErrorHandler</code> assigned, or null if none.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#getExpandEntities()">getExpandEntities</a></strong>()</code>
<div class="block">Returns whether or not entities are being expanded into normal text
content.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/jdom/JDOMFactory.html" title="interface in org.jdom">JDOMFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#getFactory()">getFactory</a></strong>()</code>
<div class="block">Returns the current <a href="../../../org/jdom/JDOMFactory.html" title="interface in org.jdom"><code>JDOMFactory</code></a> in use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#getIgnoringBoundaryWhitespace()">getIgnoringBoundaryWhitespace</a></strong>()</code>
<div class="block">Returns whether or not the parser will elminate element content
containing only whitespace.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#getIgnoringElementContentWhitespace()">getIgnoringElementContentWhitespace</a></strong>()</code>
<div class="block">Returns whether element content whitespace is to be ignored during the
build.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#getReuseParser()">getReuseParser</a></strong>()</code>
<div class="block">Returns whether the contained SAX parser instance is reused across
multiple parses.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#getValidation()">getValidation</a></strong>()</code>
<div class="block">Returns whether validation is to be performed during the build.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.xml.sax.XMLFilter</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#getXMLFilter()">getXMLFilter</a></strong>()</code>
<div class="block">Returns the <code>XMLFilter</code> used during parsing, or null if none.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setDTDHandler(org.xml.sax.DTDHandler)">setDTDHandler</a></strong>(org.xml.sax.DTDHandler dtdHandler)</code>
<div class="block">This sets custom DTDHandler for the <code>Builder</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setEntityResolver(org.xml.sax.EntityResolver)">setEntityResolver</a></strong>(org.xml.sax.EntityResolver entityResolver)</code>
<div class="block">This sets custom EntityResolver for the <code>Builder</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setErrorHandler(org.xml.sax.ErrorHandler)">setErrorHandler</a></strong>(org.xml.sax.ErrorHandler errorHandler)</code>
<div class="block">This sets custom ErrorHandler for the <code>Builder</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setExpandEntities(boolean)">setExpandEntities</a></strong>(boolean expand)</code>
<div class="block">
This sets whether or not to expand entities for the builder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setFactory(org.jdom.JDOMFactory)">setFactory</a></strong>(<a href="../../../org/jdom/JDOMFactory.html" title="interface in org.jdom">JDOMFactory</a> factory)</code>
<div class="block">This sets a custom JDOMFactory for the builder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setFastReconfigure(boolean)">setFastReconfigure</a></strong>(boolean fastReconfigure)</code>
<div class="block">Specifies whether this builder will do fast reconfiguration of the
underlying SAX parser when reuseParser is true.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setFeature(java.lang.String, boolean)">setFeature</a></strong>(java.lang.String name,
boolean value)</code>
<div class="block">This sets a feature on the SAX parser.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setIgnoringBoundaryWhitespace(boolean)">setIgnoringBoundaryWhitespace</a></strong>(boolean ignoringBoundaryWhite)</code>
<div class="block">Specifies whether or not the parser should elminate boundary whitespace,
a term that indicates whitespace-only text between element tags.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setIgnoringElementContentWhitespace(boolean)">setIgnoringElementContentWhitespace</a></strong>(boolean ignoringWhite)</code>
<div class="block">Specifies whether or not the parser should elminate whitespace in
element content (sometimes known as "ignorable whitespace") when
building the document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setProperty(java.lang.String, java.lang.Object)">setProperty</a></strong>(java.lang.String name,
java.lang.Object value)</code>
<div class="block">This sets a property on the SAX parser.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setReuseParser(boolean)">setReuseParser</a></strong>(boolean reuseParser)</code>
<div class="block">Specifies whether this builder shall reuse the same SAX parser
when performing subsequent parses or allocate a new parser for
each parse.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setValidation(boolean)">setValidation</a></strong>(boolean validate)</code>
<div class="block">This sets validation for the builder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/input/SAXBuilder.html#setXMLFilter(org.xml.sax.XMLFilter)">setXMLFilter</a></strong>(org.xml.sax.XMLFilter xmlFilter)</code>
<div class="block">This sets a custom <code>XMLFilter</code> for the builder.</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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SAXBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXBuilder</h4>
<pre>public SAXBuilder()</pre>
<div class="block">Creates a new SAXBuilder which will attempt to first locate
a parser via JAXP, then will try to use a set of default
SAX Drivers. The underlying parser will not validate.</div>
</li>
</ul>
<a name="SAXBuilder(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXBuilder</h4>
<pre>public SAXBuilder(boolean validate)</pre>
<div class="block">Creates a new SAXBuilder which will attempt to first locate
a parser via JAXP, then will try to use a set of default
SAX Drivers. The underlying parser will validate or not
according to the given parameter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>validate</code> - <code>boolean</code> indicating if
validation should occur.</dd></dl>
</li>
</ul>
<a name="SAXBuilder(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXBuilder</h4>
<pre>public SAXBuilder(java.lang.String saxDriverClass)</pre>
<div class="block">Creates a new SAXBuilder using the specified SAX parser.
The underlying parser will not validate.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>saxDriverClass</code> - <code>String</code> name of SAX Driver
to use for parsing.</dd></dl>
</li>
</ul>
<a name="SAXBuilder(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SAXBuilder</h4>
<pre>public SAXBuilder(java.lang.String saxDriverClass,
boolean validate)</pre>
<div class="block">Creates a new SAXBuilder using the specified SAX parser.
The underlying parser will validate or not
according to the given parameter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>saxDriverClass</code> - <code>String</code> name of SAX Driver
to use for parsing.</dd><dd><code>validate</code> - <code>boolean</code> indicating if
validation should occur.</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="getDriverClass()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDriverClass</h4>
<pre>public java.lang.String getDriverClass()</pre>
<div class="block">Returns the driver class assigned in the constructor, or null if none.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the driver class assigned in the constructor</dd></dl>
</li>
</ul>
<a name="getFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactory</h4>
<pre>public <a href="../../../org/jdom/JDOMFactory.html" title="interface in org.jdom">JDOMFactory</a> getFactory()</pre>
<div class="block">Returns the current <a href="../../../org/jdom/JDOMFactory.html" title="interface in org.jdom"><code>JDOMFactory</code></a> in use.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the factory in use</dd></dl>
</li>
</ul>
<a name="setFactory(org.jdom.JDOMFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFactory</h4>
<pre>public void setFactory(<a href="../../../org/jdom/JDOMFactory.html" title="interface in org.jdom">JDOMFactory</a> factory)</pre>
<div class="block">This sets a custom JDOMFactory for the builder. Use this to build
the tree with your own subclasses of the JDOM classes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - <code>JDOMFactory</code> to use</dd></dl>
</li>
</ul>
<a name="getValidation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValidation</h4>
<pre>public boolean getValidation()</pre>
<div class="block">Returns whether validation is to be performed during the build.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether validation is to be performed during the build</dd></dl>
</li>
</ul>
<a name="setValidation(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValidation</h4>
<pre>public void setValidation(boolean validate)</pre>
<div class="block">This sets validation for the builder.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>validate</code> - <code>boolean</code> indicating whether validation
should occur.</dd></dl>
</li>
</ul>
<a name="getErrorHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorHandler</h4>
<pre>public org.xml.sax.ErrorHandler getErrorHandler()</pre>
<div class="block">Returns the <code>ErrorHandler</code> assigned, or null if none.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the ErrorHandler assigned, or null if none</dd></dl>
</li>
</ul>
<a name="setErrorHandler(org.xml.sax.ErrorHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setErrorHandler</h4>
<pre>public void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)</pre>
<div class="block">This sets custom ErrorHandler for the <code>Builder</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>errorHandler</code> - <code>ErrorHandler</code></dd></dl>
</li>
</ul>
<a name="getEntityResolver()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntityResolver</h4>
<pre>public org.xml.sax.EntityResolver getEntityResolver()</pre>
<div class="block">Returns the <code>EntityResolver</code> assigned, or null if none.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the EntityResolver assigned</dd></dl>
</li>
</ul>
<a name="setEntityResolver(org.xml.sax.EntityResolver)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEntityResolver</h4>
<pre>public void setEntityResolver(org.xml.sax.EntityResolver entityResolver)</pre>
<div class="block">This sets custom EntityResolver for the <code>Builder</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entityResolver</code> - <code>EntityResolver</code></dd></dl>
</li>
</ul>
<a name="getDTDHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDTDHandler</h4>
<pre>public org.xml.sax.DTDHandler getDTDHandler()</pre>
<div class="block">Returns the <code>DTDHandler</code> assigned, or null if none.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the DTDHandler assigned</dd></dl>
</li>
</ul>
<a name="setDTDHandler(org.xml.sax.DTDHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDTDHandler</h4>
<pre>public void setDTDHandler(org.xml.sax.DTDHandler dtdHandler)</pre>
<div class="block">This sets custom DTDHandler for the <code>Builder</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dtdHandler</code> - <code>DTDHandler</code></dd></dl>
</li>
</ul>
<a name="getXMLFilter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXMLFilter</h4>
<pre>public org.xml.sax.XMLFilter getXMLFilter()</pre>
<div class="block">Returns the <code>XMLFilter</code> used during parsing, or null if none.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the XMLFilter used during parsing</dd></dl>
</li>
</ul>
<a name="setXMLFilter(org.xml.sax.XMLFilter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setXMLFilter</h4>
<pre>public void setXMLFilter(org.xml.sax.XMLFilter xmlFilter)</pre>
<div class="block">This sets a custom <code>XMLFilter</code> for the builder.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlFilter</code> - the filter to use</dd></dl>
</li>
</ul>
<a name="getIgnoringElementContentWhitespace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIgnoringElementContentWhitespace</h4>
<pre>public boolean getIgnoringElementContentWhitespace()</pre>
<div class="block">Returns whether element content whitespace is to be ignored during the
build.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether element content whitespace is to be ignored during the
build</dd></dl>
</li>
</ul>
<a name="setIgnoringElementContentWhitespace(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIgnoringElementContentWhitespace</h4>
<pre>public void setIgnoringElementContentWhitespace(boolean ignoringWhite)</pre>
<div class="block">Specifies whether or not the parser should elminate whitespace in
element content (sometimes known as "ignorable whitespace") when
building the document. Only whitespace which is contained within
element content that has an element only content model will be
eliminated (see XML Rec 3.2.1). For this setting to take effect
requires that validation be turned on. The default value of this
setting is <code>false</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoringWhite</code> - Whether to ignore ignorable whitespace</dd></dl>
</li>
</ul>
<a name="getIgnoringBoundaryWhitespace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIgnoringBoundaryWhitespace</h4>
<pre>public boolean getIgnoringBoundaryWhitespace()</pre>
<div class="block">Returns whether or not the parser will elminate element content
containing only whitespace.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>boolean</code> - whether only whitespace content will
be ignored during build.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/jdom/input/SAXBuilder.html#setIgnoringBoundaryWhitespace(boolean)"><code>setIgnoringBoundaryWhitespace(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="setIgnoringBoundaryWhitespace(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIgnoringBoundaryWhitespace</h4>
<pre>public void setIgnoringBoundaryWhitespace(boolean ignoringBoundaryWhite)</pre>
<div class="block">Specifies whether or not the parser should elminate boundary whitespace,
a term that indicates whitespace-only text between element tags. This
feature is a lot like <a href="../../../org/jdom/input/SAXBuilder.html#setIgnoringElementContentWhitespace(boolean)"><code>setIgnoringElementContentWhitespace(boolean)</code></a>
but this feature is more aggressive and doesn't require validation be
turned on. The <a href="../../../org/jdom/input/SAXBuilder.html#setIgnoringElementContentWhitespace(boolean)"><code>setIgnoringElementContentWhitespace(boolean)</code></a>
call impacts the SAX parse process while this method impacts the JDOM
build process, so it can be beneficial to turn both on for efficiency.
For implementation efficiency, this method actually removes all
whitespace-only text() nodes. That can, in some cases (like beteween an
element tag and a comment), include whitespace that isn't just boundary
whitespace. The default is <code>false</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoringBoundaryWhite</code> - Whether to ignore whitespace-only text
noes</dd></dl>
</li>
</ul>
<a name="getReuseParser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReuseParser</h4>
<pre>public boolean getReuseParser()</pre>
<div class="block">Returns whether the contained SAX parser instance is reused across
multiple parses. The default is true.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether the contained SAX parser instance is reused across
multiple parses</dd></dl>
</li>
</ul>
<a name="setReuseParser(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReuseParser</h4>
<pre>public void setReuseParser(boolean reuseParser)</pre>
<div class="block">Specifies whether this builder shall reuse the same SAX parser
when performing subsequent parses or allocate a new parser for
each parse. The default value of this setting is
<code>true</code> (parser reuse).
<p>
<strong>Note</strong>: As SAX parser instances are not thread safe,
the parser reuse feature should not be used with SAXBuilder instances
shared among threads.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reuseParser</code> - Whether to reuse the SAX parser.</dd></dl>
</li>
</ul>
<a name="setFastReconfigure(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFastReconfigure</h4>
<pre>public void setFastReconfigure(boolean fastReconfigure)</pre>
<div class="block">Specifies whether this builder will do fast reconfiguration of the
underlying SAX parser when reuseParser is true. This improves
performance in cases where SAXBuilders are reused and lots of small
documents are frequently parsed. This avoids attempting to set features
on the SAX parser each time build() is called which result in
SaxNotRecognizedExceptions. This should ONLY be set for builders where
this specific case is an issue. The default value of this setting is
<code>false</code> (no fast reconfiguration). If reuseParser is false,
calling this has no effect.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fastReconfigure</code> - Whether to do a fast reconfiguration of the parser</dd></dl>
</li>
</ul>
<a name="setFeature(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFeature</h4>
<pre>public void setFeature(java.lang.String name,
boolean value)</pre>
<div class="block">This sets a feature on the SAX parser. See the SAX documentation for .
more information.
</p>
<p>
NOTE: SAXBuilder requires that some particular features of the SAX parser be
set up in certain ways for it to work properly. The list of such features
may change in the future. Therefore, the use of this method may cause
parsing to break, and even if it doesn't break anything today it might
break parsing in a future JDOM version, because what JDOM parsers require
may change over time. Use with caution.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The feature name, which is a fully-qualified URI.</dd><dd><code>value</code> - The requested state of the feature (true or false).</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 name,
java.lang.Object value)</pre>
<div class="block">This sets a property on the SAX parser. See the SAX documentation for
more information.
<p>
NOTE: SAXBuilder requires that some particular properties of the SAX parser be
set up in certain ways for it to work properly. The list of such properties
may change in the future. Therefore, the use of this method may cause
parsing to break, and even if it doesn't break anything today it might
break parsing in a future JDOM version, because what JDOM parsers require
may change over time. Use with caution.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The property name, which is a fully-qualified URI.</dd><dd><code>value</code> - The requested value for the property.</dd></dl>
</li>
</ul>
<a name="build(org.xml.sax.InputSource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../org/jdom/Document.html" title="class in org.jdom">Document</a> build(org.xml.sax.InputSource in)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a>,
java.io.IOException</pre>
<div class="block">This builds a document from the supplied
input source.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - <code>InputSource</code> to read from</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>Document</code> resultant Document object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - when errors occur in parsing</dd>
<dd><code>java.io.IOException</code> - when an I/O error prevents a document
from being fully parsed</dd></dl>
</li>
</ul>
<a name="createContentHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createContentHandler</h4>
<pre>protected <a href="../../../org/jdom/input/SAXHandler.html" title="class in org.jdom.input">SAXHandler</a> createContentHandler()</pre>
<div class="block">This creates the SAXHandler that will be used to build the Document.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>SAXHandler</code> - resultant SAXHandler object.</dd></dl>
</li>
</ul>
<a name="configureContentHandler(org.jdom.input.SAXHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureContentHandler</h4>
<pre>protected void configureContentHandler(<a href="../../../org/jdom/input/SAXHandler.html" title="class in org.jdom.input">SAXHandler</a> contentHandler)</pre>
<div class="block">This configures the SAXHandler that will be used to build the Document.
<p>
The default implementation simply passes through some configuration
settings that were set on the SAXBuilder: setExpandEntities() and
setIgnoringElementContentWhitespace().
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>contentHandler</code> - The SAXHandler to configure</dd></dl>
</li>
</ul>
<a name="createParser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createParser</h4>
<pre>protected org.xml.sax.XMLReader createParser()
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></pre>
<div class="block">This creates the XMLReader to be used for reading the XML document.
<p>
The default behavior is to (1) use the saxDriverClass, if it has been
set, (2) try to obtain a parser from JAXP, if it is available, and
(3) if all else fails, use a hard-coded default parser (currently
the Xerces parser). Subclasses may override this method to determine
the parser to use in a different way.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>XMLReader</code> - resultant XMLReader object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code></dd></dl>
</li>
</ul>
<a name="configureParser(org.xml.sax.XMLReader, org.jdom.input.SAXHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureParser</h4>
<pre>protected void configureParser(org.xml.sax.XMLReader parser,
<a href="../../../org/jdom/input/SAXHandler.html" title="class in org.jdom.input">SAXHandler</a> contentHandler)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></pre>
<div class="block">This configures the XMLReader to be used for reading the XML document.
<p>
The default implementation sets various options on the given XMLReader,
such as validation, DTD resolution, entity handlers, etc., according
to the options that were set (e.g. via <code>setEntityResolver</code>)
and set various SAX properties and features that are required for JDOM
internals. These features may change in future releases, so change this
behavior at your own risk.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parser</code> - </dd><dd><code>contentHandler</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code></dd></dl>
</li>
</ul>
<a name="build(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../org/jdom/Document.html" title="class in org.jdom">Document</a> build(java.io.InputStream in)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a>,
java.io.IOException</pre>
<div class="block"><p>
This builds a document from the supplied
input stream.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - <code>InputStream</code> to read from</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>Document</code> resultant Document object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - when errors occur in parsing</dd>
<dd><code>java.io.IOException</code> - when an I/O error prevents a document
from being fully parsed.</dd></dl>
</li>
</ul>
<a name="build(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../org/jdom/Document.html" title="class in org.jdom">Document</a> build(java.io.File file)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a>,
java.io.IOException</pre>
<div class="block"><p>
This builds a document from the supplied
filename.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - <code>File</code> to read from</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>Document</code> resultant Document object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - when errors occur in parsing</dd>
<dd><code>java.io.IOException</code> - when an I/O error prevents a document
from being fully parsed</dd></dl>
</li>
</ul>
<a name="build(java.net.URL)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../org/jdom/Document.html" title="class in org.jdom">Document</a> build(java.net.URL url)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a>,
java.io.IOException</pre>
<div class="block"><p>
This builds a document from the supplied
URL.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - <code>URL</code> to read from.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>Document</code> - resultant Document object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - when errors occur in parsing</dd>
<dd><code>java.io.IOException</code> - when an I/O error prevents a document
from being fully parsed.</dd></dl>
</li>
</ul>
<a name="build(java.io.InputStream, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../org/jdom/Document.html" title="class in org.jdom">Document</a> build(java.io.InputStream in,
java.lang.String systemId)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a>,
java.io.IOException</pre>
<div class="block"><p>
This builds a document from the supplied
input stream.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - <code>InputStream</code> to read from.</dd><dd><code>systemId</code> - base for resolving relative URIs</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>Document</code> resultant Document object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - when errors occur in parsing</dd>
<dd><code>java.io.IOException</code> - when an I/O error prevents a document
from being fully parsed</dd></dl>
</li>
</ul>
<a name="build(java.io.Reader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../org/jdom/Document.html" title="class in org.jdom">Document</a> build(java.io.Reader characterStream)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a>,
java.io.IOException</pre>
<div class="block"><p>
This builds a document from the supplied
Reader. It's the programmer's responsibility to make sure
the reader matches the encoding of the file. It's often easier
and safer to use an InputStream rather than a Reader, and to let the
parser auto-detect the encoding from the XML declaration.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>characterStream</code> - <code>Reader</code> to read from</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>Document</code> resultant Document object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - when errors occur in parsing</dd>
<dd><code>java.io.IOException</code> - when an I/O error prevents a document
from being fully parsed</dd></dl>
</li>
</ul>
<a name="build(java.io.Reader, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../org/jdom/Document.html" title="class in org.jdom">Document</a> build(java.io.Reader characterStream,
java.lang.String systemId)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a>,
java.io.IOException</pre>
<div class="block"><p>
This builds a document from the supplied
Reader. It's the programmer's responsibility to make sure
the reader matches the encoding of the file. It's often easier
and safer to use an InputStream rather than a Reader, and to let the
parser auto-detect the encoding from the XML declaration.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>characterStream</code> - <code>Reader</code> to read from.</dd><dd><code>systemId</code> - base for resolving relative URIs</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>Document</code> resultant Document object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - when errors occur in parsing</dd>
<dd><code>java.io.IOException</code> - when an I/O error prevents a document
from being fully parsed</dd></dl>
</li>
</ul>
<a name="build(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../org/jdom/Document.html" title="class in org.jdom">Document</a> build(java.lang.String systemId)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a>,
java.io.IOException</pre>
<div class="block"><p>
This builds a document from the supplied
URI.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemId</code> - URI for the input</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>Document</code> resultant Document object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - when errors occur in parsing</dd>
<dd><code>java.io.IOException</code> - when an I/O error prevents a document
from being fully parsed</dd></dl>
</li>
</ul>
<a name="getExpandEntities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpandEntities</h4>
<pre>public boolean getExpandEntities()</pre>
<div class="block">Returns whether or not entities are being expanded into normal text
content.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether entities are being expanded</dd></dl>
</li>
</ul>
<a name="setExpandEntities(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setExpandEntities</h4>
<pre>public void setExpandEntities(boolean expand)</pre>
<div class="block"><p>
This sets whether or not to expand entities for the builder.
A true means to expand entities as normal content. A false means to
leave entities unexpanded as <code>EntityRef</code> objects. The
default is true.
</p>
<p>
When this setting is false, the internal DTD subset is retained; when
this setting is true, the internal DTD subset is not retained.
</p>
<p>
Note that Xerces (at least up to 1.4.4) has a bug where entities
in attribute values will be misreported if this flag is turned off,
resulting in entities to appear within element content. When turning
entity expansion off either avoid entities in attribute values, or
use another parser like Crimson.
http://nagoya.apache.org/bugzilla/show_bug.cgi?id=6111
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expand</code> - <code>boolean</code> indicating whether entity expansion
should occur.</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/SAXBuilder.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/input/JDOMParseException.html" title="class in org.jdom.input"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../org/jdom/input/SAXHandler.html" title="class in org.jdom.input"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom/input/SAXBuilder.html" target="_top">FRAMES</a></li>
<li><a href="SAXBuilder.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><a href="#constructor_summary">CONSTR</a> | </li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL: </li>
<li>FIELD | </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>
|