/usr/share/doc/libjenkins-dom4j-java/api/org/dom4j/io/SAXReader.html is in libjenkins-dom4j-java-doc 1.6.1-jenkins-4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 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 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_65) on Thu Sep 11 11:01:38 UTC 2014 -->
<title>SAXReader (dom4j API)</title>
<meta name="date" content="2014-09-11">
<link rel="stylesheet" type="text/css" href="../../../javadoc.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SAXReader (dom4j API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SAXReader.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/dom4j/io/SAXModifier.html" title="class in org.dom4j.io"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/dom4j/io/SAXReader.SAXEntityResolver.html" title="class in org.dom4j.io"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/dom4j/io/SAXReader.html" target="_top">Frames</a></li>
<li><a href="SAXReader.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><a href="#nested_class_summary">Nested</a> | </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">
<div class="subTitle">org.dom4j.io</div>
<h2 title="Class SAXReader" class="title">Class SAXReader</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.dom4j.io.SAXReader</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">SAXReader</span>
extends java.lang.Object</pre>
<div class="block"><p>
<code>SAXReader</code> creates a DOM4J tree from SAX parsing events.
</p>
<p>
The actual SAX parser that is used by this class is configurable so you can
use your favourite SAX parser if you wish. DOM4J comes configured with its
own SAX parser so you do not need to worry about configuring the SAX parser.
</p>
<p>
To explicitly configure the SAX parser that is used via Java code you can use
a constructor or use the <a href="../../../org/dom4j/io/SAXReader.html#setXMLReader(org.xml.sax.XMLReader)"><code>setXMLReader(XMLReader)</code></a>or <a href="../../../org/dom4j/io/SAXReader.html#setXMLReaderClassName(java.lang.String)"><code>setXMLReaderClassName(String)</code></a> methods.
</p>
<p>
If the parser is not specified explicitly then the standard SAX policy of
using the <code>org.xml.sax.driver</code> system property is used to
determine the implementation class of <code>XMLReader</code>.
</p>
<p>
If the <code>org.xml.sax.driver</code> system property is not defined then
JAXP is used via reflection (so that DOM4J is not explicitly dependent on the
JAXP classes) to load the JAXP configured SAXParser. If there is any error
creating a JAXP SAXParser an informational message is output and then the
default (Aelfred) SAX parser is used instead.
</p>
<p>
If you are trying to use JAXP to explicitly set your SAX parser and are
experiencing problems, you can turn on verbose error reporting by defining
the system property <code>org.dom4j.verbose</code> to be "true" which will
output a more detailed description of why JAXP could not find a SAX parser
</p>
<p>
For more information on JAXP please go to <a
href="http://java.sun.com/xml/">Sun's Java & XML site </a>
</p></div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.58 $</dd>
<dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:james.strachan@metastuff.com">James Strachan </a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static class </code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.SAXEntityResolver.html" title="class in org.dom4j.io">SAXReader.SAXEntityResolver</a></strong></code> </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/dom4j/io/SAXReader.html#SAXReader()">SAXReader</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#SAXReader(boolean)">SAXReader</a></strong>(boolean validating)</code> </td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#SAXReader(org.dom4j.DocumentFactory)">SAXReader</a></strong>(<a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</a> factory)</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#SAXReader(org.dom4j.DocumentFactory,%20boolean)">SAXReader</a></strong>(<a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</a> factory,
boolean validating)</code> </td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#SAXReader(java.lang.String)">SAXReader</a></strong>(java.lang.String xmlReaderClassName)</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#SAXReader(java.lang.String,%20boolean)">SAXReader</a></strong>(java.lang.String xmlReaderClassName,
boolean validating)</code> </td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#SAXReader(org.xml.sax.XMLReader)">SAXReader</a></strong>(org.xml.sax.XMLReader xmlReader)</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#SAXReader(org.xml.sax.XMLReader,%20boolean)">SAXReader</a></strong>(org.xml.sax.XMLReader xmlReader,
boolean validating)</code> </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>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#addHandler(java.lang.String,%20org.dom4j.ElementHandler)">addHandler</a></strong>(java.lang.String path,
<a href="../../../org/dom4j/ElementHandler.html" title="interface in org.dom4j">ElementHandler</a> handler)</code>
<div class="block">Adds the <code>ElementHandler</code> to be called when the specified
path is encounted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#configureReader(org.xml.sax.XMLReader,%20org.xml.sax.helpers.DefaultHandler)">configureReader</a></strong>(org.xml.sax.XMLReader reader,
org.xml.sax.helpers.DefaultHandler handler)</code>
<div class="block">Configures the XMLReader before use</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../org/dom4j/io/SAXContentHandler.html" title="class in org.dom4j.io">SAXContentHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#createContentHandler(org.xml.sax.XMLReader)">createContentHandler</a></strong>(org.xml.sax.XMLReader reader)</code>
<div class="block">Factory Method to allow user derived SAXContentHandler objects to be used</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.xml.sax.EntityResolver</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#createDefaultEntityResolver(java.lang.String)">createDefaultEntityResolver</a></strong>(java.lang.String systemId)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.xml.sax.XMLReader</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#createXMLReader()">createXMLReader</a></strong>()</code>
<div class="block">Factory Method to allow alternate methods of creating and configuring
XMLReader objects</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.dom4j.io.DispatchHandler</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#getDispatchHandler()">getDispatchHandler</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#getDocumentFactory()">getDocumentFactory</a></strong>()</code>
<div class="block">DOCUMENT ME!</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#getEncoding()">getEncoding</a></strong>()</code>
<div class="block">Returns encoding used for InputSource (null means system default
encoding)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.xml.sax.EntityResolver</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#getEntityResolver()">getEntityResolver</a></strong>()</code>
<div class="block">Returns the current entity resolver used to resolve entities</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.xml.sax.ErrorHandler</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#getErrorHandler()">getErrorHandler</a></strong>()</code>
<div class="block">DOCUMENT ME!</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.xml.sax.XMLFilter</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#getXMLFilter()">getXMLFilter</a></strong>()</code>
<div class="block">Returns the SAX filter being used to filter SAX events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.xml.sax.XMLReader</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#getXMLReader()">getXMLReader</a></strong>()</code>
<div class="block">DOCUMENT ME!</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.xml.sax.XMLReader</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#installXMLFilter(org.xml.sax.XMLReader)">installXMLFilter</a></strong>(org.xml.sax.XMLReader reader)</code>
<div class="block">Installs any XMLFilter objects required to allow the SAX event stream to
be filtered and preprocessed before it gets to dom4j.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#isIgnoreComments()">isIgnoreComments</a></strong>()</code>
<div class="block">Returns whether we should ignore comments or not.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#isIncludeExternalDTDDeclarations()">isIncludeExternalDTDDeclarations</a></strong>()</code>
<div class="block">DOCUMENT ME!</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#isIncludeInternalDTDDeclarations()">isIncludeInternalDTDDeclarations</a></strong>()</code>
<div class="block">DOCUMENT ME!</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#isMergeAdjacentText()">isMergeAdjacentText</a></strong>()</code>
<div class="block">Returns whether adjacent text nodes should be merged together.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#isStringInternEnabled()">isStringInternEnabled</a></strong>()</code>
<div class="block">Sets whether String interning is enabled or disabled for element &
attribute names and namespace URIs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#isStripWhitespaceText()">isStripWhitespaceText</a></strong>()</code>
<div class="block">Sets whether whitespace between element start and end tags should be
ignored</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#isValidating()">isValidating</a></strong>()</code>
<div class="block">DOCUMENT ME!</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#read(java.io.File)">read</a></strong>(java.io.File file)</code>
<div class="block">
Reads a Document from the given <code>File</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#read(org.xml.sax.InputSource)">read</a></strong>(org.xml.sax.InputSource in)</code>
<div class="block">
Reads a Document from the given <code>InputSource</code> using SAX</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#read(java.io.InputStream)">read</a></strong>(java.io.InputStream in)</code>
<div class="block">
Reads a Document from the given stream using SAX</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#read(java.io.InputStream,%20java.lang.String)">read</a></strong>(java.io.InputStream in,
java.lang.String systemId)</code>
<div class="block">
Reads a Document from the given stream using SAX</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#read(java.io.Reader)">read</a></strong>(java.io.Reader reader)</code>
<div class="block">
Reads a Document from the given <code>Reader</code> using SAX</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#read(java.io.Reader,%20java.lang.String)">read</a></strong>(java.io.Reader reader,
java.lang.String systemId)</code>
<div class="block">
Reads a Document from the given <code>Reader</code> using SAX</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#read(java.lang.String)">read</a></strong>(java.lang.String systemId)</code>
<div class="block">
Reads a Document from the given URL or filename using SAX.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#read(java.net.URL)">read</a></strong>(java.net.URL url)</code>
<div class="block">
Reads a Document from the given <code>URL</code> using SAX</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#removeHandler(java.lang.String)">removeHandler</a></strong>(java.lang.String path)</code>
<div class="block">Removes the <code>ElementHandler</code> from the event based processor,
for the specified path.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#resetHandlers()">resetHandlers</a></strong>()</code>
<div class="block">This method clears out all the existing handlers and default handler
setting things back as if no handler existed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setDefaultHandler(org.dom4j.ElementHandler)">setDefaultHandler</a></strong>(<a href="../../../org/dom4j/ElementHandler.html" title="interface in org.dom4j">ElementHandler</a> handler)</code>
<div class="block">When multiple <code>ElementHandler</code> instances have been
registered, this will set a default <code>ElementHandler</code> to be
called for any path which does <b>NOT </b> have a handler registered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setDispatchHandler(org.dom4j.io.DispatchHandler)">setDispatchHandler</a></strong>(org.dom4j.io.DispatchHandler dispatchHandler)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setDocumentFactory(org.dom4j.DocumentFactory)">setDocumentFactory</a></strong>(<a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</a> documentFactory)</code>
<div class="block">
This sets the <code>DocumentFactory</code> used to create new
documents.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setEncoding(java.lang.String)">setEncoding</a></strong>(java.lang.String encoding)</code>
<div class="block">Sets encoding used for InputSource (null means system default encoding)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setEntityResolver(org.xml.sax.EntityResolver)">setEntityResolver</a></strong>(org.xml.sax.EntityResolver entityResolver)</code>
<div class="block">Sets the entity resolver used to resolve entities.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setErrorHandler(org.xml.sax.ErrorHandler)">setErrorHandler</a></strong>(org.xml.sax.ErrorHandler errorHandler)</code>
<div class="block">Sets the <code>ErrorHandler</code> used by the SAX
<code>XMLReader</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setFeature(java.lang.String,%20boolean)">setFeature</a></strong>(java.lang.String name,
boolean value)</code>
<div class="block">Sets a SAX feature on the underlying SAX parser.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setIgnoreComments(boolean)">setIgnoreComments</a></strong>(boolean ignoreComments)</code>
<div class="block">Sets whether we should ignore comments or not.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setIncludeExternalDTDDeclarations(boolean)">setIncludeExternalDTDDeclarations</a></strong>(boolean include)</code>
<div class="block">Sets whether DTD external declarations should be expanded into the
DocumentType object or not.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setIncludeInternalDTDDeclarations(boolean)">setIncludeInternalDTDDeclarations</a></strong>(boolean include)</code>
<div class="block">Sets whether internal DTD declarations should be expanded into the
DocumentType object or not.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setMergeAdjacentText(boolean)">setMergeAdjacentText</a></strong>(boolean mergeAdjacentText)</code>
<div class="block">Sets whether or not adjacent text nodes should be merged together when
parsing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setProperty(java.lang.String,%20java.lang.Object)">setProperty</a></strong>(java.lang.String name,
java.lang.Object value)</code>
<div class="block">Allows a SAX property to be set on the underlying SAX parser.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setStringInternEnabled(boolean)">setStringInternEnabled</a></strong>(boolean stringInternEnabled)</code>
<div class="block">Sets whether String interning is enabled or disabled for element &
attribute names and namespace URIs</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setStripWhitespaceText(boolean)">setStripWhitespaceText</a></strong>(boolean stripWhitespaceText)</code>
<div class="block">Sets whether whitespace between element start and end tags should be
ignored.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setValidation(boolean)">setValidation</a></strong>(boolean validation)</code>
<div class="block">Sets the validation mode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setXMLFilter(org.xml.sax.XMLFilter)">setXMLFilter</a></strong>(org.xml.sax.XMLFilter filter)</code>
<div class="block">Sets the SAX filter to be used when filtering SAX events</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setXMLReader(org.xml.sax.XMLReader)">setXMLReader</a></strong>(org.xml.sax.XMLReader reader)</code>
<div class="block">Sets the <code>XMLReader</code> used to parse SAX events</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXReader.html#setXMLReaderClassName(java.lang.String)">setXMLReaderClassName</a></strong>(java.lang.String xmlReaderClassName)</code>
<div class="block">Sets the class name of the <code>XMLReader</code> to be used to parse
SAX events.</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="SAXReader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXReader</h4>
<pre>public SAXReader()</pre>
</li>
</ul>
<a name="SAXReader(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXReader</h4>
<pre>public SAXReader(boolean validating)</pre>
</li>
</ul>
<a name="SAXReader(org.dom4j.DocumentFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXReader</h4>
<pre>public SAXReader(<a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</a> factory)</pre>
</li>
</ul>
<a name="SAXReader(org.dom4j.DocumentFactory, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXReader</h4>
<pre>public SAXReader(<a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</a> factory,
boolean validating)</pre>
</li>
</ul>
<a name="SAXReader(org.xml.sax.XMLReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXReader</h4>
<pre>public SAXReader(org.xml.sax.XMLReader xmlReader)</pre>
</li>
</ul>
<a name="SAXReader(org.xml.sax.XMLReader, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXReader</h4>
<pre>public SAXReader(org.xml.sax.XMLReader xmlReader,
boolean validating)</pre>
</li>
</ul>
<a name="SAXReader(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXReader</h4>
<pre>public SAXReader(java.lang.String xmlReaderClassName)
throws org.xml.sax.SAXException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code></dd></dl>
</li>
</ul>
<a name="SAXReader(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SAXReader</h4>
<pre>public SAXReader(java.lang.String xmlReaderClassName,
boolean validating)
throws org.xml.sax.SAXException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code></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="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)
throws org.xml.sax.SAXException</pre>
<div class="block">Allows a SAX property to be set on the underlying SAX parser. This can be
useful to set parser-specific properties such as the location of schema
or DTD resources. Though use this method with caution as it has the
possibility of breaking the standard behaviour. An alternative to calling
this method is to correctly configure an XMLReader object instance and
call the <a href="../../../org/dom4j/io/SAXReader.html#setXMLReader(org.xml.sax.XMLReader)"><code>setXMLReader(XMLReader)</code></a>method</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - is the SAX property name</dd><dd><code>value</code> - is the value of the SAX property</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - if the XMLReader could not be created or the property could
not be changed.</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)
throws org.xml.sax.SAXException</pre>
<div class="block">Sets a SAX feature on the underlying SAX parser. This can be useful to
set parser-specific features. Though use this method with caution as it
has the possibility of breaking the standard behaviour. An alternative to
calling this method is to correctly configure an XMLReader object
instance and call the <a href="../../../org/dom4j/io/SAXReader.html#setXMLReader(org.xml.sax.XMLReader)"><code>setXMLReader(XMLReader)</code></a>method</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - is the SAX feature name</dd><dd><code>value</code> - is the value of the SAX feature</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - if the XMLReader could not be created or the feature could
not be changed.</dd></dl>
</li>
</ul>
<a name="read(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> read(java.io.File file)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block"><p>
Reads a Document from the given <code>File</code>
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - is the <code>File</code> to read from.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the newly created Document instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></code> - if an error occurs during parsing.</dd></dl>
</li>
</ul>
<a name="read(java.net.URL)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> read(java.net.URL url)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block"><p>
Reads a Document from the given <code>URL</code> using SAX
</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>the newly created Document instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></code> - if an error occurs during parsing.</dd></dl>
</li>
</ul>
<a name="read(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> read(java.lang.String systemId)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block"><p>
Reads a Document from the given URL or filename using SAX.
</p>
<p>
If the systemId contains a <code>':'</code> character then it is
assumed to be a URL otherwise its assumed to be a file name. If you want
finer grained control over this mechansim then please explicitly pass in
either a <code>URL</code>or a <code>File</code>instance instead of a <code>String</code> to denote the source of the document.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemId</code> - is a URL for a document or a file name.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the newly created Document instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></code> - if an error occurs during parsing.</dd></dl>
</li>
</ul>
<a name="read(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> read(java.io.InputStream in)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block"><p>
Reads a Document from the given stream using SAX
</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>the newly created Document instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></code> - if an error occurs during parsing.</dd></dl>
</li>
</ul>
<a name="read(java.io.Reader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> read(java.io.Reader reader)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block"><p>
Reads a Document from the given <code>Reader</code> using SAX
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - is the reader for the input</dd>
<dt><span class="strong">Returns:</span></dt><dd>the newly created Document instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></code> - if an error occurs during parsing.</dd></dl>
</li>
</ul>
<a name="read(java.io.InputStream, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> read(java.io.InputStream in,
java.lang.String systemId)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block"><p>
Reads a Document from the given stream using SAX
</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> - is the URI for the input</dd>
<dt><span class="strong">Returns:</span></dt><dd>the newly created Document instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></code> - if an error occurs during parsing.</dd></dl>
</li>
</ul>
<a name="read(java.io.Reader, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> read(java.io.Reader reader,
java.lang.String systemId)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block"><p>
Reads a Document from the given <code>Reader</code> using SAX
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - is the reader for the input</dd><dd><code>systemId</code> - is the URI for the input</dd>
<dt><span class="strong">Returns:</span></dt><dd>the newly created Document instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></code> - if an error occurs during parsing.</dd></dl>
</li>
</ul>
<a name="read(org.xml.sax.InputSource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> read(org.xml.sax.InputSource in)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block"><p>
Reads a Document from the given <code>InputSource</code> using SAX
</p></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>the newly created Document instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></code> - if an error occurs during parsing.</dd></dl>
</li>
</ul>
<a name="isValidating()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidating</h4>
<pre>public boolean isValidating()</pre>
<div class="block">DOCUMENT ME!</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the validation mode, true if validating will be done otherwise
false.</dd></dl>
</li>
</ul>
<a name="setValidation(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValidation</h4>
<pre>public void setValidation(boolean validation)</pre>
<div class="block">Sets the validation mode.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>validation</code> - indicates whether or not validation should occur.</dd></dl>
</li>
</ul>
<a name="isIncludeInternalDTDDeclarations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIncludeInternalDTDDeclarations</h4>
<pre>public boolean isIncludeInternalDTDDeclarations()</pre>
<div class="block">DOCUMENT ME!</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether internal DTD declarations should be expanded into the
DocumentType object or not.</dd></dl>
</li>
</ul>
<a name="setIncludeInternalDTDDeclarations(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIncludeInternalDTDDeclarations</h4>
<pre>public void setIncludeInternalDTDDeclarations(boolean include)</pre>
<div class="block">Sets whether internal DTD declarations should be expanded into the
DocumentType object or not.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>include</code> - whether or not DTD declarations should be expanded and
included into the DocumentType object.</dd></dl>
</li>
</ul>
<a name="isIncludeExternalDTDDeclarations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIncludeExternalDTDDeclarations</h4>
<pre>public boolean isIncludeExternalDTDDeclarations()</pre>
<div class="block">DOCUMENT ME!</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether external DTD declarations should be expanded into the
DocumentType object or not.</dd></dl>
</li>
</ul>
<a name="setIncludeExternalDTDDeclarations(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIncludeExternalDTDDeclarations</h4>
<pre>public void setIncludeExternalDTDDeclarations(boolean include)</pre>
<div class="block">Sets whether DTD external declarations should be expanded into the
DocumentType object or not.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>include</code> - whether or not DTD declarations should be expanded and
included into the DocumentType object.</dd></dl>
</li>
</ul>
<a name="isStringInternEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStringInternEnabled</h4>
<pre>public boolean isStringInternEnabled()</pre>
<div class="block">Sets whether String interning is enabled or disabled for element &
attribute names and namespace URIs. This proprety is enabled by default.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="setStringInternEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStringInternEnabled</h4>
<pre>public void setStringInternEnabled(boolean stringInternEnabled)</pre>
<div class="block">Sets whether String interning is enabled or disabled for element &
attribute names and namespace URIs</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stringInternEnabled</code> - DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="isMergeAdjacentText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMergeAdjacentText</h4>
<pre>public boolean isMergeAdjacentText()</pre>
<div class="block">Returns whether adjacent text nodes should be merged together.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Value of property mergeAdjacentText.</dd></dl>
</li>
</ul>
<a name="setMergeAdjacentText(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMergeAdjacentText</h4>
<pre>public void setMergeAdjacentText(boolean mergeAdjacentText)</pre>
<div class="block">Sets whether or not adjacent text nodes should be merged together when
parsing.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mergeAdjacentText</code> - New value of property mergeAdjacentText.</dd></dl>
</li>
</ul>
<a name="isStripWhitespaceText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStripWhitespaceText</h4>
<pre>public boolean isStripWhitespaceText()</pre>
<div class="block">Sets whether whitespace between element start and end tags should be
ignored</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Value of property stripWhitespaceText.</dd></dl>
</li>
</ul>
<a name="setStripWhitespaceText(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStripWhitespaceText</h4>
<pre>public void setStripWhitespaceText(boolean stripWhitespaceText)</pre>
<div class="block">Sets whether whitespace between element start and end tags should be
ignored.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stripWhitespaceText</code> - New value of property stripWhitespaceText.</dd></dl>
</li>
</ul>
<a name="isIgnoreComments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIgnoreComments</h4>
<pre>public boolean isIgnoreComments()</pre>
<div class="block">Returns whether we should ignore comments or not.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>boolean</dd></dl>
</li>
</ul>
<a name="setIgnoreComments(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIgnoreComments</h4>
<pre>public void setIgnoreComments(boolean ignoreComments)</pre>
<div class="block">Sets whether we should ignore comments or not.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoreComments</code> - whether we should ignore comments or not.</dd></dl>
</li>
</ul>
<a name="getDocumentFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocumentFactory</h4>
<pre>public <a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</a> getDocumentFactory()</pre>
<div class="block">DOCUMENT ME!</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>DocumentFactory</code> used to create document
objects</dd></dl>
</li>
</ul>
<a name="setDocumentFactory(org.dom4j.DocumentFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDocumentFactory</h4>
<pre>public void setDocumentFactory(<a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</a> documentFactory)</pre>
<div class="block"><p>
This sets the <code>DocumentFactory</code> used to create new
documents. This method allows the building of custom DOM4J tree objects
to be implemented easily using a custom derivation of
<a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>documentFactory</code> - <code>DocumentFactory</code> used to create DOM4J objects</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">DOCUMENT ME!</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>ErrorHandler</code> used by SAX</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">Sets the <code>ErrorHandler</code> used by the SAX
<code>XMLReader</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>errorHandler</code> - is the <code>ErrorHandler</code> used by SAX</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 current entity resolver used to resolve entities</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>DOCUMENT ME!</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">Sets the entity resolver used to resolve entities.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entityResolver</code> - DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="getXMLReader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXMLReader</h4>
<pre>public org.xml.sax.XMLReader getXMLReader()
throws org.xml.sax.SAXException</pre>
<div class="block">DOCUMENT ME!</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>XMLReader</code> used to parse SAX events</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="setXMLReader(org.xml.sax.XMLReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setXMLReader</h4>
<pre>public void setXMLReader(org.xml.sax.XMLReader reader)</pre>
<div class="block">Sets the <code>XMLReader</code> used to parse SAX events</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - is the <code>XMLReader</code> to parse SAX events</dd></dl>
</li>
</ul>
<a name="getEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncoding</h4>
<pre>public java.lang.String getEncoding()</pre>
<div class="block">Returns encoding used for InputSource (null means system default
encoding)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>encoding used for InputSource</dd></dl>
</li>
</ul>
<a name="setEncoding(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEncoding</h4>
<pre>public void setEncoding(java.lang.String encoding)</pre>
<div class="block">Sets encoding used for InputSource (null means system default encoding)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>encoding</code> - is encoding used for InputSource</dd></dl>
</li>
</ul>
<a name="setXMLReaderClassName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setXMLReaderClassName</h4>
<pre>public void setXMLReaderClassName(java.lang.String xmlReaderClassName)
throws org.xml.sax.SAXException</pre>
<div class="block">Sets the class name of the <code>XMLReader</code> to be used to parse
SAX events.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlReaderClassName</code> - is the class name of the <code>XMLReader</code> to parse SAX
events</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="addHandler(java.lang.String, org.dom4j.ElementHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addHandler</h4>
<pre>public void addHandler(java.lang.String path,
<a href="../../../org/dom4j/ElementHandler.html" title="interface in org.dom4j">ElementHandler</a> handler)</pre>
<div class="block">Adds the <code>ElementHandler</code> to be called when the specified
path is encounted.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - is the path to be handled</dd><dd><code>handler</code> - is the <code>ElementHandler</code> to be called by the event
based processor.</dd></dl>
</li>
</ul>
<a name="removeHandler(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeHandler</h4>
<pre>public void removeHandler(java.lang.String path)</pre>
<div class="block">Removes the <code>ElementHandler</code> from the event based processor,
for the specified path.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - is the path to remove the <code>ElementHandler</code> for.</dd></dl>
</li>
</ul>
<a name="setDefaultHandler(org.dom4j.ElementHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultHandler</h4>
<pre>public void setDefaultHandler(<a href="../../../org/dom4j/ElementHandler.html" title="interface in org.dom4j">ElementHandler</a> handler)</pre>
<div class="block">When multiple <code>ElementHandler</code> instances have been
registered, this will set a default <code>ElementHandler</code> to be
called for any path which does <b>NOT </b> have a handler registered.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - is the <code>ElementHandler</code> to be called by the event
based processor.</dd></dl>
</li>
</ul>
<a name="resetHandlers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetHandlers</h4>
<pre>public void resetHandlers()</pre>
<div class="block">This method clears out all the existing handlers and default handler
setting things back as if no handler existed. Useful when reusing an
object instance.</div>
</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 SAX filter being used to filter SAX events.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the SAX filter being used or null if no SAX filter is installed</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 filter)</pre>
<div class="block">Sets the SAX filter to be used when filtering SAX events</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - is the SAX filter to use or null to disable filtering</dd></dl>
</li>
</ul>
<a name="installXMLFilter(org.xml.sax.XMLReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>installXMLFilter</h4>
<pre>protected org.xml.sax.XMLReader installXMLFilter(org.xml.sax.XMLReader reader)</pre>
<div class="block">Installs any XMLFilter objects required to allow the SAX event stream to
be filtered and preprocessed before it gets to dom4j.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - DOCUMENT ME!</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new XMLFilter if applicable or the original XMLReader if no
filter is being used.</dd></dl>
</li>
</ul>
<a name="getDispatchHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDispatchHandler</h4>
<pre>protected org.dom4j.io.DispatchHandler getDispatchHandler()</pre>
</li>
</ul>
<a name="setDispatchHandler(org.dom4j.io.DispatchHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDispatchHandler</h4>
<pre>protected void setDispatchHandler(org.dom4j.io.DispatchHandler dispatchHandler)</pre>
</li>
</ul>
<a name="createXMLReader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createXMLReader</h4>
<pre>protected org.xml.sax.XMLReader createXMLReader()
throws org.xml.sax.SAXException</pre>
<div class="block">Factory Method to allow alternate methods of creating and configuring
XMLReader objects</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>DOCUMENT ME!</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="configureReader(org.xml.sax.XMLReader, org.xml.sax.helpers.DefaultHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureReader</h4>
<pre>protected void configureReader(org.xml.sax.XMLReader reader,
org.xml.sax.helpers.DefaultHandler handler)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block">Configures the XMLReader before use</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - DOCUMENT ME!</dd><dd><code>handler</code> - DOCUMENT ME!</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></code> - DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="createContentHandler(org.xml.sax.XMLReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createContentHandler</h4>
<pre>protected <a href="../../../org/dom4j/io/SAXContentHandler.html" title="class in org.dom4j.io">SAXContentHandler</a> createContentHandler(org.xml.sax.XMLReader reader)</pre>
<div class="block">Factory Method to allow user derived SAXContentHandler objects to be used</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - DOCUMENT ME!</dd>
<dt><span class="strong">Returns:</span></dt><dd>DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="createDefaultEntityResolver(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createDefaultEntityResolver</h4>
<pre>protected org.xml.sax.EntityResolver createDefaultEntityResolver(java.lang.String systemId)</pre>
</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/SAXReader.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/dom4j/io/SAXModifier.html" title="class in org.dom4j.io"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/dom4j/io/SAXReader.SAXEntityResolver.html" title="class in org.dom4j.io"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/dom4j/io/SAXReader.html" target="_top">Frames</a></li>
<li><a href="SAXReader.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><a href="#nested_class_summary">Nested</a> | </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 ? 2005 MetaStuff Ltd. All Rights Reserved. Hosted by <p> <img src='http://sourceforge.net/sflogo.php?group_id=16035' width='88' height='31' border='0' alt='SourceForge Logo' /></small></p>
</body>
</html>
|