/usr/share/doc/libjenkins-dom4j-java/api/org/dom4j/io/SAXModifier.html is in libjenkins-dom4j-java-doc 1.6.1-hudson-3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Thu Oct 20 11:18:53 UTC 2011 -->
<TITLE>
SAXModifier (dom4j API)
</TITLE>
<META NAME="date" CONTENT="2011-10-20">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../javadoc.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SAXModifier (dom4j API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SAXModifier.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/dom4j/io/SAXEventRecorder.html" title="class in org.dom4j.io"><B>PREV CLASS</B></A>
<A HREF="../../../org/dom4j/io/SAXReader.html" title="class in org.dom4j.io"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/dom4j/io/SAXModifier.html" target="_top"><B>FRAMES</B></A>
<A HREF="SAXModifier.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.dom4j.io</FONT>
<BR>
Class SAXModifier</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.dom4j.io.SAXModifier</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>SAXModifier</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
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>
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>Wonne Keysers (Realsoftware.be)</DD>
<DT><B>See Also:</B><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></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#SAXModifier()">SAXModifier</A></B>()</CODE>
<BR>
Creates a new modifier.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#SAXModifier(boolean)">SAXModifier</A></B>(boolean pruneElements)</CODE>
<BR>
Creates a new modifier.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#SAXModifier(org.xml.sax.XMLReader)">SAXModifier</A></B>(org.xml.sax.XMLReader xmlReader)</CODE>
<BR>
Creates a new modifier that will the specified <CODE>XMLReader</CODE> to parse the source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#SAXModifier(org.xml.sax.XMLReader, boolean)">SAXModifier</A></B>(org.xml.sax.XMLReader xmlReader,
boolean pruneElements)</CODE>
<BR>
Creates a new modifier that will the specified <CODE>XMLReader</CODE> to parse the source.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#addModifier(java.lang.String, org.dom4j.io.ElementModifier)">addModifier</A></B>(java.lang.String path,
<A HREF="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io">ElementModifier</A> modifier)</CODE>
<BR>
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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#getDocumentFactory()">getDocumentFactory</A></B>()</CODE>
<BR>
Get the <A HREF="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><CODE>DocumentFactory</CODE></A>used to create the DOM4J
document structure</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io">XMLWriter</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#getXMLWriter()">getXMLWriter</A></B>()</CODE>
<BR>
Returns the current <A HREF="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><CODE>XMLWriter</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#isPruneElements()">isPruneElements</A></B>()</CODE>
<BR>
Returns true when xml elements are not kept in memory while parsing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#modify(java.io.File)">modify</A></B>(java.io.File source)</CODE>
<BR>
Reads a Document from the given <CODE>File</CODE>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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#modify(org.xml.sax.InputSource)">modify</A></B>(org.xml.sax.InputSource source)</CODE>
<BR>
Reads a Document from the given <CODE>InputSource</CODE>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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#modify(java.io.InputStream)">modify</A></B>(java.io.InputStream source)</CODE>
<BR>
Reads a Document from the given <CODE>InputStream</CODE>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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#modify(java.io.InputStream, java.lang.String)">modify</A></B>(java.io.InputStream source,
java.lang.String systemId)</CODE>
<BR>
Reads a Document from the given <CODE>InputStream</CODE>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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#modify(java.io.Reader)">modify</A></B>(java.io.Reader source)</CODE>
<BR>
Reads a Document from the given <CODE>Reader</CODE>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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#modify(java.io.Reader, java.lang.String)">modify</A></B>(java.io.Reader source,
java.lang.String systemId)</CODE>
<BR>
Reads a Document from the given <CODE>Reader</CODE>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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#modify(java.lang.String)">modify</A></B>(java.lang.String source)</CODE>
<BR>
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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#modify(java.net.URL)">modify</A></B>(java.net.URL source)</CODE>
<BR>
Reads a Document from the given <CODE>URL</CODE>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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#removeModifier(java.lang.String)">removeModifier</A></B>(java.lang.String path)</CODE>
<BR>
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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#resetModifiers()">resetModifiers</A></B>()</CODE>
<BR>
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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#setDocumentFactory(org.dom4j.DocumentFactory)">setDocumentFactory</A></B>(<A HREF="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</A> factory)</CODE>
<BR>
Sets the <A HREF="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><CODE>DocumentFactory</CODE></A>used to create the DOM4J
document tree.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/io/SAXModifier.html#setXMLWriter(org.dom4j.io.XMLWriter)">setXMLWriter</A></B>(<A HREF="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io">XMLWriter</A> writer)</CODE>
<BR>
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.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="SAXModifier()"><!-- --></A><H3>
SAXModifier</H3>
<PRE>
public <B>SAXModifier</B>()</PRE>
<DL>
<DD>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.
<P>
</DL>
<HR>
<A NAME="SAXModifier(boolean)"><!-- --></A><H3>
SAXModifier</H3>
<PRE>
public <B>SAXModifier</B>(boolean pruneElements)</PRE>
<DL>
<DD>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.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>pruneElements</CODE> - Set to true when the modified document must NOT be kept in
memory.</DL>
</DL>
<HR>
<A NAME="SAXModifier(org.xml.sax.XMLReader)"><!-- --></A><H3>
SAXModifier</H3>
<PRE>
public <B>SAXModifier</B>(org.xml.sax.XMLReader xmlReader)</PRE>
<DL>
<DD>Creates a new modifier that will the specified <CODE>XMLReader</CODE> to parse the source.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>xmlReader</CODE> - The XMLReader to use</DL>
</DL>
<HR>
<A NAME="SAXModifier(org.xml.sax.XMLReader, boolean)"><!-- --></A><H3>
SAXModifier</H3>
<PRE>
public <B>SAXModifier</B>(org.xml.sax.XMLReader xmlReader,
boolean pruneElements)</PRE>
<DL>
<DD>Creates a new modifier that will the specified <CODE>XMLReader</CODE> to parse the source.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>xmlReader</CODE> - The XMLReader to use<DD><CODE>pruneElements</CODE> - Set to true when the modified document must NOT be kept in
memory.</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="modify(java.io.File)"><!-- --></A><H3>
modify</H3>
<PRE>
public <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A> <B>modify</B>(java.io.File source)
throws <A HREF="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</A></PRE>
<DL>
<DD>Reads a Document from the given <CODE>File</CODE>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - is the <code>File</code> to read from.
<DT><B>Returns:</B><DD>the newly created Document instance
<DT><B>Throws:</B>
<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.</DL>
</DD>
</DL>
<HR>
<A NAME="modify(org.xml.sax.InputSource)"><!-- --></A><H3>
modify</H3>
<PRE>
public <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A> <B>modify</B>(org.xml.sax.InputSource source)
throws <A HREF="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</A></PRE>
<DL>
<DD>Reads a Document from the given <CODE>InputSource</CODE>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - is the <code>org.xml.sax.InputSource</code> to read from.
<DT><B>Returns:</B><DD>the newly created Document instance
<DT><B>Throws:</B>
<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.</DL>
</DD>
</DL>
<HR>
<A NAME="modify(java.io.InputStream)"><!-- --></A><H3>
modify</H3>
<PRE>
public <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A> <B>modify</B>(java.io.InputStream source)
throws <A HREF="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</A></PRE>
<DL>
<DD>Reads a Document from the given <CODE>InputStream</CODE>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - is the <code>java.io.InputStream</code> to read from.
<DT><B>Returns:</B><DD>the newly created Document instance
<DT><B>Throws:</B>
<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.</DL>
</DD>
</DL>
<HR>
<A NAME="modify(java.io.InputStream, java.lang.String)"><!-- --></A><H3>
modify</H3>
<PRE>
public <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A> <B>modify</B>(java.io.InputStream source,
java.lang.String systemId)
throws <A HREF="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</A></PRE>
<DL>
<DD>Reads a Document from the given <CODE>InputStream</CODE>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - is the <code>java.io.InputStream</code> to read from.<DD><CODE>systemId</CODE> - DOCUMENT ME!
<DT><B>Returns:</B><DD>the newly created Document instance
<DT><B>Throws:</B>
<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.</DL>
</DD>
</DL>
<HR>
<A NAME="modify(java.io.Reader)"><!-- --></A><H3>
modify</H3>
<PRE>
public <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A> <B>modify</B>(java.io.Reader source)
throws <A HREF="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</A></PRE>
<DL>
<DD>Reads a Document from the given <CODE>Reader</CODE>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - is the <code>java.io.Reader</code> to read from.
<DT><B>Returns:</B><DD>the newly created Document instance
<DT><B>Throws:</B>
<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.</DL>
</DD>
</DL>
<HR>
<A NAME="modify(java.io.Reader, java.lang.String)"><!-- --></A><H3>
modify</H3>
<PRE>
public <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A> <B>modify</B>(java.io.Reader source,
java.lang.String systemId)
throws <A HREF="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</A></PRE>
<DL>
<DD>Reads a Document from the given <CODE>Reader</CODE>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - is the <code>java.io.Reader</code> to read from.<DD><CODE>systemId</CODE> - DOCUMENT ME!
<DT><B>Returns:</B><DD>the newly created Document instance
<DT><B>Throws:</B>
<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.</DL>
</DD>
</DL>
<HR>
<A NAME="modify(java.net.URL)"><!-- --></A><H3>
modify</H3>
<PRE>
public <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A> <B>modify</B>(java.net.URL source)
throws <A HREF="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</A></PRE>
<DL>
<DD>Reads a Document from the given <CODE>URL</CODE>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - is the <code>java.net.URL</code> to read from.
<DT><B>Returns:</B><DD>the newly created Document instance
<DT><B>Throws:</B>
<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.</DL>
</DD>
</DL>
<HR>
<A NAME="modify(java.lang.String)"><!-- --></A><H3>
modify</H3>
<PRE>
public <A HREF="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</A> <B>modify</B>(java.lang.String source)
throws <A HREF="../../../org/dom4j/DocumentException.html" title="class in org.dom4j">DocumentException</A></PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - is the URL or filename to read from.
<DT><B>Returns:</B><DD>the newly created Document instance
<DT><B>Throws:</B>
<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.</DL>
</DD>
</DL>
<HR>
<A NAME="addModifier(java.lang.String, org.dom4j.io.ElementModifier)"><!-- --></A><H3>
addModifier</H3>
<PRE>
public void <B>addModifier</B>(java.lang.String path,
<A HREF="../../../org/dom4j/io/ElementModifier.html" title="interface in org.dom4j.io">ElementModifier</A> modifier)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - The element path to be handled<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.</DL>
</DD>
</DL>
<HR>
<A NAME="resetModifiers()"><!-- --></A><H3>
resetModifiers</H3>
<PRE>
public void <B>resetModifiers</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="removeModifier(java.lang.String)"><!-- --></A><H3>
removeModifier</H3>
<PRE>
public void <B>removeModifier</B>(java.lang.String path)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><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.</DL>
</DD>
</DL>
<HR>
<A NAME="getDocumentFactory()"><!-- --></A><H3>
getDocumentFactory</H3>
<PRE>
public <A HREF="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</A> <B>getDocumentFactory</B>()</PRE>
<DL>
<DD>Get the <A HREF="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><CODE>DocumentFactory</CODE></A>used to create the DOM4J
document structure
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>DocumentFactory</code> that will be used</DL>
</DD>
</DL>
<HR>
<A NAME="setDocumentFactory(org.dom4j.DocumentFactory)"><!-- --></A><H3>
setDocumentFactory</H3>
<PRE>
public void <B>setDocumentFactory</B>(<A HREF="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</A> factory)</PRE>
<DL>
<DD>Sets the <A HREF="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><CODE>DocumentFactory</CODE></A>used to create the DOM4J
document tree.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>factory</CODE> - <code>DocumentFactory</code> to be used</DL>
</DD>
</DL>
<HR>
<A NAME="getXMLWriter()"><!-- --></A><H3>
getXMLWriter</H3>
<PRE>
public <A HREF="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io">XMLWriter</A> <B>getXMLWriter</B>()</PRE>
<DL>
<DD>Returns the current <A HREF="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><CODE>XMLWriter</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>XMLWriter</DL>
</DD>
</DL>
<HR>
<A NAME="setXMLWriter(org.dom4j.io.XMLWriter)"><!-- --></A><H3>
setXMLWriter</H3>
<PRE>
public void <B>setXMLWriter</B>(<A HREF="../../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io">XMLWriter</A> writer)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>writer</CODE> - The writer to use.</DL>
</DD>
</DL>
<HR>
<A NAME="isPruneElements()"><!-- --></A><H3>
isPruneElements</H3>
<PRE>
public boolean <B>isPruneElements</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>Returns the pruneElements.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SAXModifier.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/dom4j/io/SAXEventRecorder.html" title="class in org.dom4j.io"><B>PREV CLASS</B></A>
<A HREF="../../../org/dom4j/io/SAXReader.html" title="class in org.dom4j.io"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/dom4j/io/SAXModifier.html" target="_top"><B>FRAMES</B></A>
<A HREF="SAXModifier.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
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' />
</BODY>
</HTML>
|