/usr/share/doc/libjenkins-dom4j-java/api/org/dom4j/io/SAXModifier.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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_65) on Thu Sep 04 18:10:39 UTC 2014 -->
<title>SAXModifier (dom4j API)</title>
<meta name="date" content="2014-09-04">
<link rel="stylesheet" type="text/css" href="../../../javadoc.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SAXModifier (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/SAXModifier.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/SAXEventRecorder.html" title="class in org.dom4j.io"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/dom4j/io/SAXReader.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/SAXModifier.html" target="_top">Frames</a></li>
<li><a href="SAXModifier.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">
<div class="subTitle">org.dom4j.io</div>
<h2 title="Class SAXModifier" class="title">Class SAXModifier</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.dom4j.io.SAXModifier</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">SAXModifier</span>
extends <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">The SAXModifier reads, modifies and writes XML documents using SAX.
<p>
Registered <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a>objects can provide modifications to (part
of) the xml tree, while the document is still being processed. This makes it
possible to change large xml documents without having them in memory.
</p>
<p>
The modified document is written when the <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>is specified.
</p></div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Wonne Keysers (Realsoftware.be)</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/dom4j/io/SAXReader.html" title="class in org.dom4j.io"><code>SAXReader</code></a>,
<a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a></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/dom4j/io/SAXModifier.html#SAXModifier()">SAXModifier</a></strong>()</code>
<div class="block">Creates a new modifier.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/SAXModifier.html#SAXModifier(boolean)">SAXModifier</a></strong>(boolean pruneElements)</code>
<div class="block">Creates a new modifier.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/SAXModifier.html#SAXModifier(org.xml.sax.XMLReader)">SAXModifier</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax">XMLReader</a> xmlReader)</code>
<div class="block">Creates a new modifier that will the specified <a href="file:///usr/share/doc/default-jdk/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax"><code>XMLReader</code></a> to parse the source.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/SAXModifier.html#SAXModifier(org.xml.sax.XMLReader,%20boolean)">SAXModifier</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax">XMLReader</a> xmlReader,
boolean pruneElements)</code>
<div class="block">Creates a new modifier that will the specified <a href="file:///usr/share/doc/default-jdk/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax"><code>XMLReader</code></a> to parse the source.</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXModifier.html#addModifier(java.lang.String,%20org.dom4j.io.ElementModifier)">addModifier</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path,
<a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io">ElementModifier</a> modifier)</code>
<div class="block">Adds the <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a>to be called when the specified element
path is encounted while parsing the source.</div>
</td>
</tr>
<tr class="rowColor">
<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/SAXModifier.html#getDocumentFactory()">getDocumentFactory</a></strong>()</code>
<div class="block">Get the <a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>used to create the DOM4J
document structure</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io">XMLWriter</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXModifier.html#getXMLWriter()">getXMLWriter</a></strong>()</code>
<div class="block">Returns the current <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXModifier.html#isPruneElements()">isPruneElements</a></strong>()</code>
<div class="block">Returns true when xml elements are not kept in memory while parsing.</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/SAXModifier.html#modify(java.io.File)">modify</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> source)</code>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a>and writes it to the
specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>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/SAXModifier.html#modify(org.xml.sax.InputSource)">modify</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/org/xml/sax/InputSource.html?is-external=true" title="class or interface in org.xml.sax">InputSource</a> source)</code>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/org/xml/sax/InputSource.html?is-external=true" title="class or interface in org.xml.sax"><code>InputSource</code></a>and
writes it to the specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>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/SAXModifier.html#modify(java.io.InputStream)">modify</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> source)</code>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>and writes it
to the specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>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/SAXModifier.html#modify(java.io.InputStream,%20java.lang.String)">modify</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> source,
<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> systemId)</code>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>and writes it
to the specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>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/SAXModifier.html#modify(java.io.Reader)">modify</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> source)</code>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a>and writes it to
the specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>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/SAXModifier.html#modify(java.io.Reader,%20java.lang.String)">modify</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> source,
<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> systemId)</code>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a>and writes it to
the specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>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/SAXModifier.html#modify(java.lang.String)">modify</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source)</code>
<div class="block">Reads a Document from the given URL or filename and writes it to the
specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>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/SAXModifier.html#modify(java.net.URL)">modify</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> source)</code>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/java/net/URL.html?is-external=true" title="class or interface in java.net"><code>URL</code></a>and writes it to the
specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>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/SAXModifier.html#removeModifier(java.lang.String)">removeModifier</a></strong>(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</code>
<div class="block">Removes the <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a>from the event based processor, for
the specified element path.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXModifier.html#resetModifiers()">resetModifiers</a></strong>()</code>
<div class="block">Removes all registered <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a>instances from the event
based processor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXModifier.html#setDocumentFactory(org.dom4j.DocumentFactory)">setDocumentFactory</a></strong>(<a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</a> factory)</code>
<div class="block">Sets the <a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>used to create the DOM4J
document tree.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/SAXModifier.html#setXMLWriter(org.dom4j.io.XMLWriter)">setXMLWriter</a></strong>(<a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io">XMLWriter</a> writer)</code>
<div class="block">Sets the <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>used to write the modified document.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SAXModifier()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXModifier</h4>
<pre>public SAXModifier()</pre>
<div class="block">Creates a new modifier. <br>
The XMLReader to parse the source will be created via the
org.xml.sax.driver system property or JAXP if the system property is not
set.</div>
</li>
</ul>
<a name="SAXModifier(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXModifier</h4>
<pre>public SAXModifier(boolean pruneElements)</pre>
<div class="block">Creates a new modifier. <br>
The XMLReader to parse the source will be created via the
org.xml.sax.driver system property or JAXP if the system property is not
set.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pruneElements</code> - Set to true when the modified document must NOT be kept in
memory.</dd></dl>
</li>
</ul>
<a name="SAXModifier(org.xml.sax.XMLReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAXModifier</h4>
<pre>public SAXModifier(<a href="file:///usr/share/doc/default-jdk/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax">XMLReader</a> xmlReader)</pre>
<div class="block">Creates a new modifier that will the specified <a href="file:///usr/share/doc/default-jdk/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax"><code>XMLReader</code></a> to parse the source.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlReader</code> - The XMLReader to use</dd></dl>
</li>
</ul>
<a name="SAXModifier(org.xml.sax.XMLReader, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SAXModifier</h4>
<pre>public SAXModifier(<a href="file:///usr/share/doc/default-jdk/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax">XMLReader</a> xmlReader,
boolean pruneElements)</pre>
<div class="block">Creates a new modifier that will the specified <a href="file:///usr/share/doc/default-jdk/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax"><code>XMLReader</code></a> to parse the source.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlReader</code> - The XMLReader to use</dd><dd><code>pruneElements</code> - Set to true when the modified document must NOT be kept in
memory.</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="modify(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>modify</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> modify(<a href="file:///usr/share/doc/default-jdk/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> source)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a>and writes it to the
specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>using SAX. Registered
objects are invoked on the fly.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</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> - DocumentException org.dom4j.DocumentException} if an error
occurs during parsing.</dd></dl>
</li>
</ul>
<a name="modify(org.xml.sax.InputSource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>modify</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> modify(<a href="file:///usr/share/doc/default-jdk/api/org/xml/sax/InputSource.html?is-external=true" title="class or interface in org.xml.sax">InputSource</a> source)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/org/xml/sax/InputSource.html?is-external=true" title="class or interface in org.xml.sax"><code>InputSource</code></a>and
writes it to the specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>using SAX. Registered
<a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a>objects are invoked on the fly.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - is the <code>org.xml.sax.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> - DocumentException org.dom4j.DocumentException} if an error
occurs during parsing.</dd></dl>
</li>
</ul>
<a name="modify(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>modify</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> modify(<a href="file:///usr/share/doc/default-jdk/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> source)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>and writes it
to the specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>using SAX. Registered <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a> objects are invoked on the fly.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - is the <code>java.io.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> - DocumentException org.dom4j.DocumentException} if an error
occurs during parsing.</dd></dl>
</li>
</ul>
<a name="modify(java.io.InputStream, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>modify</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> modify(<a href="file:///usr/share/doc/default-jdk/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> source,
<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> systemId)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>and writes it
to the specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>using SAX. Registered <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a> objects are invoked on the fly.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - is the <code>java.io.InputStream</code> to read from.</dd><dd><code>systemId</code> - DOCUMENT ME!</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> - DocumentException org.dom4j.DocumentException} if an error
occurs during parsing.</dd></dl>
</li>
</ul>
<a name="modify(java.io.Reader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>modify</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> modify(<a href="file:///usr/share/doc/default-jdk/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> source)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a>and writes it to
the specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>using SAX. Registered <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a> objects are invoked on the fly.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - is the <code>java.io.Reader</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> - DocumentException org.dom4j.DocumentException} if an error
occurs during parsing.</dd></dl>
</li>
</ul>
<a name="modify(java.io.Reader, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>modify</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> modify(<a href="file:///usr/share/doc/default-jdk/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> source,
<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> systemId)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a>and writes it to
the specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>using SAX. Registered <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a> objects are invoked on the fly.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - is the <code>java.io.Reader</code> to read from.</dd><dd><code>systemId</code> - DOCUMENT ME!</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> - DocumentException org.dom4j.DocumentException} if an error
occurs during parsing.</dd></dl>
</li>
</ul>
<a name="modify(java.net.URL)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>modify</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> modify(<a href="file:///usr/share/doc/default-jdk/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> source)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block">Reads a Document from the given <a href="file:///usr/share/doc/default-jdk/api/java/net/URL.html?is-external=true" title="class or interface in java.net"><code>URL</code></a>and writes it to the
specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>using SAX. Registered
objects are invoked on the fly.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - is the <code>java.net.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> - DocumentException org.dom4j.DocumentException} if an error
occurs during parsing.</dd></dl>
</li>
</ul>
<a name="modify(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>modify</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> modify(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source)
throws <a href="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</a></pre>
<div class="block">Reads a Document from the given URL or filename and writes it to the
specified <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>using SAX. Registered
objects are invoked on the fly.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - is the URL or filename 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> - DocumentException org.dom4j.DocumentException} if an error
occurs during parsing.</dd></dl>
</li>
</ul>
<a name="addModifier(java.lang.String, org.dom4j.io.ElementModifier)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addModifier</h4>
<pre>public void addModifier(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path,
<a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io">ElementModifier</a> modifier)</pre>
<div class="block">Adds the <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a>to be called when the specified element
path is encounted while parsing the source.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - The element path to be handled</dd><dd><code>modifier</code> - The <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a>to be called by the event based
processor.</dd></dl>
</li>
</ul>
<a name="resetModifiers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetModifiers</h4>
<pre>public void resetModifiers()</pre>
<div class="block">Removes all registered <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a>instances from the event
based processor.</div>
</li>
</ul>
<a name="removeModifier(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeModifier</h4>
<pre>public void removeModifier(<a href="file:///usr/share/doc/default-jdk/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</pre>
<div class="block">Removes the <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a>from the event based processor, for
the specified element path.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - The path to remove the <a href="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io"><code>ElementModifier</code></a>for.</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">Get the <a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>used to create the DOM4J
document structure</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>DocumentFactory</code> that will be used</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> factory)</pre>
<div class="block">Sets the <a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>used to create the DOM4J
document tree.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - <code>DocumentFactory</code> to be used</dd></dl>
</li>
</ul>
<a name="getXMLWriter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXMLWriter</h4>
<pre>public <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io">XMLWriter</a> getXMLWriter()</pre>
<div class="block">Returns the current <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>XMLWriter</dd></dl>
</li>
</ul>
<a name="setXMLWriter(org.dom4j.io.XMLWriter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setXMLWriter</h4>
<pre>public void setXMLWriter(<a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io">XMLWriter</a> writer)</pre>
<div class="block">Sets the <a href="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a>used to write the modified document.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>writer</code> - The writer to use.</dd></dl>
</li>
</ul>
<a name="isPruneElements()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isPruneElements</h4>
<pre>public boolean isPruneElements()</pre>
<div class="block">Returns true when xml elements are not kept in memory while parsing. The
<a href="../../../org/dom4j/Document.html" title="interface in org.dom4j"><code>Document</code></a>returned by the modify methods will be null.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the pruneElements.</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/SAXModifier.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/SAXEventRecorder.html" title="class in org.dom4j.io"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/dom4j/io/SAXReader.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/SAXModifier.html" target="_top">Frames</a></li>
<li><a href="SAXModifier.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 ? 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>
|