/usr/share/doc/libjenkins-dom4j-java/api/org/dom4j/io/STAXEventReader.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 | <!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>STAXEventReader (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="STAXEventReader (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/STAXEventReader.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/SAXWriter.html" title="class in org.dom4j.io"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/dom4j/io/STAXEventWriter.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/STAXEventReader.html" target="_top">Frames</a></li>
<li><a href="STAXEventReader.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 STAXEventReader" class="title">Class STAXEventReader</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.dom4j.io.STAXEventReader</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">STAXEventReader</span>
extends java.lang.Object</pre>
<div class="block">Reads a DOM4J <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j"><code>Document</code></a>, as well as other <a href="../../../org/dom4j/Node.html" title="interface in org.dom4j"><code>Node</code></a>s, from a StAX
<code>XMLEventReader</code>.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Christian Niles</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/STAXEventReader.html#STAXEventReader()">STAXEventReader</a></strong>()</code>
<div class="block">Constructs a default <code>STAXEventReader</code> instance with a
default <a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#STAXEventReader(org.dom4j.DocumentFactory)">STAXEventReader</a></strong>(<a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</a> factory)</code>
<div class="block">Constructs a <code>STAXEventReader</code> instance that uses the
specified <a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>to construct DOM4J <a href="../../../org/dom4j/Node.html" title="interface in org.dom4j"><code>Node</code></a>s.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Attribute.html" title="interface in org.dom4j">Attribute</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#createAttribute(org.dom4j.Element,%20javax.xml.stream.events.Attribute)">createAttribute</a></strong>(<a href="../../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> elem,
javax.xml.stream.events.Attribute attr)</code>
<div class="block">Constructs a new DOM4J Attribute from the provided StAX Attribute event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/dom4j/CharacterData.html" title="interface in org.dom4j">CharacterData</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#createCharacterData(javax.xml.stream.events.Characters)">createCharacterData</a></strong>(javax.xml.stream.events.Characters characters)</code>
<div class="block">Constructs a new DOM4J Text or CDATA object from the provided Characters
event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Comment.html" title="interface in org.dom4j">Comment</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#createComment(javax.xml.stream.events.Comment)">createComment</a></strong>(javax.xml.stream.events.Comment comment)</code>
<div class="block">Constructs a new DOM4J Comment from the provided StAX Comment event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#createElement(javax.xml.stream.events.StartElement)">createElement</a></strong>(javax.xml.stream.events.StartElement startEvent)</code>
<div class="block">Constructs a new DOM4J Element from the provided StartElement event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Entity.html" title="interface in org.dom4j">Entity</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#createEntity(javax.xml.stream.events.EntityReference)">createEntity</a></strong>(javax.xml.stream.events.EntityReference entityRef)</code>
<div class="block">Constructs a new DOM4J Entity from the provided StAX EntityReference
event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Namespace.html" title="class in org.dom4j">Namespace</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#createNamespace(javax.xml.stream.events.Namespace)">createNamespace</a></strong>(javax.xml.stream.events.Namespace ns)</code>
<div class="block">Constructs a new DOM4J Namespace from the provided StAX Namespace event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#createProcessingInstruction(javax.xml.stream.events.ProcessingInstruction)">createProcessingInstruction</a></strong>(javax.xml.stream.events.ProcessingInstruction pi)</code>
<div class="block">Constructs a new DOM4J ProcessingInstruction from the provided StAX
ProcessingInstruction event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/dom4j/QName.html" title="class in org.dom4j">QName</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#createQName(javax.xml.namespace.QName)">createQName</a></strong>(javax.xml.namespace.QName qname)</code>
<div class="block">Constructs a new DOM4J QName from the provided JAXP QName.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Attribute.html" title="interface in org.dom4j">Attribute</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#readAttribute(javax.xml.stream.XMLEventReader)">readAttribute</a></strong>(javax.xml.stream.XMLEventReader reader)</code>
<div class="block">Constructs a DOM4J Attribute from the provided event stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/dom4j/CharacterData.html" title="interface in org.dom4j">CharacterData</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#readCharacters(javax.xml.stream.XMLEventReader)">readCharacters</a></strong>(javax.xml.stream.XMLEventReader reader)</code>
<div class="block">Constructs a DOM4J Text or CDATA section from the provided event stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Comment.html" title="interface in org.dom4j">Comment</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#readComment(javax.xml.stream.XMLEventReader)">readComment</a></strong>(javax.xml.stream.XMLEventReader reader)</code>
<div class="block">Constructs a DOM4J Comment from the provided event stream.</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/STAXEventReader.html#readDocument(java.io.InputStream)">readDocument</a></strong>(java.io.InputStream is)</code>
<div class="block">Constructs a StAX event stream from the provided I/O stream and reads a
DOM4J document from it.</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/STAXEventReader.html#readDocument(java.io.InputStream,%20java.lang.String)">readDocument</a></strong>(java.io.InputStream is,
java.lang.String systemId)</code>
<div class="block">Constructs a StAX event stream from the provided I/O stream and reads a
DOM4J document from it.</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/STAXEventReader.html#readDocument(java.io.Reader)">readDocument</a></strong>(java.io.Reader reader)</code>
<div class="block">Constructs a StAX event stream from the provided I/O character stream and
reads a DOM4J document from it.</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/STAXEventReader.html#readDocument(java.io.Reader,%20java.lang.String)">readDocument</a></strong>(java.io.Reader reader,
java.lang.String systemId)</code>
<div class="block">Constructs a StAX event stream from the provided I/O character stream and
reads a DOM4J document from it.</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/STAXEventReader.html#readDocument(javax.xml.stream.XMLEventReader)">readDocument</a></strong>(javax.xml.stream.XMLEventReader reader)</code>
<div class="block">Reads a DOM4J <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j"><code>Document</code></a>from the provided stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#readElement(javax.xml.stream.XMLEventReader)">readElement</a></strong>(javax.xml.stream.XMLEventReader eventReader)</code>
<div class="block">Reads a DOM4J Element from the provided event stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Entity.html" title="interface in org.dom4j">Entity</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#readEntityReference(javax.xml.stream.XMLEventReader)">readEntityReference</a></strong>(javax.xml.stream.XMLEventReader reader)</code>
<div class="block">Constructs a DOM4J Entity from the provided event stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Namespace.html" title="class in org.dom4j">Namespace</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#readNamespace(javax.xml.stream.XMLEventReader)">readNamespace</a></strong>(javax.xml.stream.XMLEventReader reader)</code>
<div class="block">Constructs a DOM4J Namespace from the provided event stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#readNode(javax.xml.stream.XMLEventReader)">readNode</a></strong>(javax.xml.stream.XMLEventReader reader)</code>
<div class="block">Reads a <a href="../../../org/dom4j/Node.html" title="interface in org.dom4j"><code>Node</code></a>from the event stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.html#readProcessingInstruction(javax.xml.stream.XMLEventReader)">readProcessingInstruction</a></strong>(javax.xml.stream.XMLEventReader reader)</code>
<div class="block">Constructs a DOM4J ProcessingInstruction from the provided event stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/STAXEventReader.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">Sets the DocumentFactory to be used when constructing DOM4J nodes.</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="STAXEventReader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STAXEventReader</h4>
<pre>public STAXEventReader()</pre>
<div class="block">Constructs a default <code>STAXEventReader</code> instance with a
default <a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>.</div>
</li>
</ul>
<a name="STAXEventReader(org.dom4j.DocumentFactory)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>STAXEventReader</h4>
<pre>public STAXEventReader(<a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j">DocumentFactory</a> factory)</pre>
<div class="block">Constructs a <code>STAXEventReader</code> instance that uses the
specified <a href="../../../org/dom4j/DocumentFactory.html" title="class in org.dom4j"><code>DocumentFactory</code></a>to construct DOM4J <a href="../../../org/dom4j/Node.html" title="interface in org.dom4j"><code>Node</code></a>s.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - The DocumentFactory to use when constructing DOM4J nodes, or
<code>null</code> if a default should be used.</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="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">Sets the DocumentFactory to be used when constructing DOM4J nodes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>documentFactory</code> - The DocumentFactory to use when constructing DOM4J nodes, or
<code>null</code> if a default should be used.</dd></dl>
</li>
</ul>
<a name="readDocument(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readDocument</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> readDocument(java.io.InputStream is)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Constructs a StAX event stream from the provided I/O stream and reads a
DOM4J document from it.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - The I/O stream from which the Document will be read.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Document that was read from the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occurs reading content from the stream.</dd></dl>
</li>
</ul>
<a name="readDocument(java.io.Reader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readDocument</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> readDocument(java.io.Reader reader)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Constructs a StAX event stream from the provided I/O character stream and
reads a DOM4J document from it.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The character stream from which the Document will be read.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Document that was read from the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occurs reading content from the stream.</dd></dl>
</li>
</ul>
<a name="readDocument(java.io.InputStream, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readDocument</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> readDocument(java.io.InputStream is,
java.lang.String systemId)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Constructs a StAX event stream from the provided I/O stream and reads a
DOM4J document from it.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - The I/O stream from which the Document will be read.</dd><dd><code>systemId</code> - A system id used to resolve entities.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Document that was read from the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occurs reading content from the stream.</dd></dl>
</li>
</ul>
<a name="readDocument(java.io.Reader, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readDocument</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> readDocument(java.io.Reader reader,
java.lang.String systemId)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Constructs a StAX event stream from the provided I/O character stream and
reads a DOM4J document from it.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The character stream from which the Document will be read.</dd><dd><code>systemId</code> - A system id used to resolve entities.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Document that was read from the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occurs reading content from the stream.</dd></dl>
</li>
</ul>
<a name="readNode(javax.xml.stream.XMLEventReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readNode</h4>
<pre>public <a href="../../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> readNode(javax.xml.stream.XMLEventReader reader)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Reads a <a href="../../../org/dom4j/Node.html" title="interface in org.dom4j"><code>Node</code></a>from the event stream. If the next event is a
<code>StartElement</code>, all events until the closing <code>EndElement</code>
will be read, and the resulting nodes will be added to the returned
<a href="../../../org/dom4j/Element.html" title="interface in org.dom4j"><code>Element</code></a>.
<p>
<strong>Pre-Conditions </strong>: The stream must be positioned before an
event other than an <code>EndElement</code>,<code>EndDocument</code>,
or any DTD-related events, which are not currently supported.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The reader from which events will be read.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A DOM4J <a href="../../../org/dom4j/Node.html" title="interface in org.dom4j"><code>Node</code></a>constructed from the read events.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occurs reading from the stream, or the stream was
positioned before an unsupported event.</dd></dl>
</li>
</ul>
<a name="readDocument(javax.xml.stream.XMLEventReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readDocument</h4>
<pre>public <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> readDocument(javax.xml.stream.XMLEventReader reader)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Reads a DOM4J <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j"><code>Document</code></a>from the provided stream. The stream
should be positioned at the start of a document, or before a <code>StartElement</code> event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The event stream from which to read the <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j"><code>Document</code></a>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The <a href="../../../org/dom4j/Document.html" title="interface in org.dom4j"><code>Document</code></a>that was read from the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occurs reading events from the stream.</dd></dl>
</li>
</ul>
<a name="readElement(javax.xml.stream.XMLEventReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readElement</h4>
<pre>public <a href="../../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> readElement(javax.xml.stream.XMLEventReader eventReader)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Reads a DOM4J Element from the provided event stream. The stream must be
positioned before an <code>StartElement</code>event. In addition to the
initial start event, all events up to and including the closing <code>EndElement</code> will be read, and included with the returned element.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>eventReader</code> - The event stream from which to read the Element.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Element that was read from the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occured reading events from the stream, or the
stream was not positioned before a event.</dd></dl>
</li>
</ul>
<a name="readAttribute(javax.xml.stream.XMLEventReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readAttribute</h4>
<pre>public <a href="../../../org/dom4j/Attribute.html" title="interface in org.dom4j">Attribute</a> readAttribute(javax.xml.stream.XMLEventReader reader)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Constructs a DOM4J Attribute from the provided event stream. The stream
must be positioned before an <code>Attribute</code>event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The event stream from which to read the Attribute.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Attribute that was read from the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occured reading events from the stream, or the
stream was not positioned before an event.</dd></dl>
</li>
</ul>
<a name="readNamespace(javax.xml.stream.XMLEventReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readNamespace</h4>
<pre>public <a href="../../../org/dom4j/Namespace.html" title="class in org.dom4j">Namespace</a> readNamespace(javax.xml.stream.XMLEventReader reader)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Constructs a DOM4J Namespace from the provided event stream. The stream
must be positioned before a <code>Namespace</code>event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The event stream from which to read the Namespace.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Namespace that was read from the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occured reading events from the stream, or the
stream was not positioned before a event.</dd></dl>
</li>
</ul>
<a name="readCharacters(javax.xml.stream.XMLEventReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readCharacters</h4>
<pre>public <a href="../../../org/dom4j/CharacterData.html" title="interface in org.dom4j">CharacterData</a> readCharacters(javax.xml.stream.XMLEventReader reader)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Constructs a DOM4J Text or CDATA section from the provided event stream.
The stream must be positioned before a <code>Characters</code>event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The event stream from which to read the Text or CDATA.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Text or CDATA that was read from the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occured reading events from the stream, or the
stream was not positioned before a event.</dd></dl>
</li>
</ul>
<a name="readComment(javax.xml.stream.XMLEventReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readComment</h4>
<pre>public <a href="../../../org/dom4j/Comment.html" title="interface in org.dom4j">Comment</a> readComment(javax.xml.stream.XMLEventReader reader)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Constructs a DOM4J Comment from the provided event stream. The stream
must be positioned before a <code>Comment</code>event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The event stream from which to read the Comment.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Comment that was read from the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occured reading events from the stream, or the
stream was not positioned before a event.</dd></dl>
</li>
</ul>
<a name="readEntityReference(javax.xml.stream.XMLEventReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readEntityReference</h4>
<pre>public <a href="../../../org/dom4j/Entity.html" title="interface in org.dom4j">Entity</a> readEntityReference(javax.xml.stream.XMLEventReader reader)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Constructs a DOM4J Entity from the provided event stream. The stream must
be positioned before an <code>EntityReference</code>event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The event stream from which to read the <code>EntityReference</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The <a href="../../../org/dom4j/Entity.html" title="interface in org.dom4j"><code>Entity</code></a>that was read from the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occured reading events from the stream, or the
stream was not positioned before an
event.</dd></dl>
</li>
</ul>
<a name="readProcessingInstruction(javax.xml.stream.XMLEventReader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readProcessingInstruction</h4>
<pre>public <a href="../../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a> readProcessingInstruction(javax.xml.stream.XMLEventReader reader)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block">Constructs a DOM4J ProcessingInstruction from the provided event stream.
The stream must be positioned before a <code>ProcessingInstruction</code>
event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The event stream from which to read the ProcessingInstruction.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The ProcessingInstruction that was read from the stream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.xml.stream.XMLStreamException</code> - If an error occured reading events from the stream, or the
stream was not positioned before a <code>ProcessingInstruction</code> event.</dd></dl>
</li>
</ul>
<a name="createElement(javax.xml.stream.events.StartElement)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createElement</h4>
<pre>public <a href="../../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> createElement(javax.xml.stream.events.StartElement startEvent)</pre>
<div class="block">Constructs a new DOM4J Element from the provided StartElement event. All
attributes and namespaces will be added to the returned element.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>startEvent</code> - The StartElement event from which to construct the new DOM4J
Element.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Element constructed from the provided StartElement event.</dd></dl>
</li>
</ul>
<a name="createAttribute(org.dom4j.Element, javax.xml.stream.events.Attribute)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAttribute</h4>
<pre>public <a href="../../../org/dom4j/Attribute.html" title="interface in org.dom4j">Attribute</a> createAttribute(<a href="../../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> elem,
javax.xml.stream.events.Attribute attr)</pre>
<div class="block">Constructs a new DOM4J Attribute from the provided StAX Attribute event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>elem</code> - DOCUMENT ME!</dd><dd><code>attr</code> - The Attribute event from which to construct the new DOM4J
Attribute.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Attribute constructed from the provided Attribute event.</dd></dl>
</li>
</ul>
<a name="createNamespace(javax.xml.stream.events.Namespace)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createNamespace</h4>
<pre>public <a href="../../../org/dom4j/Namespace.html" title="class in org.dom4j">Namespace</a> createNamespace(javax.xml.stream.events.Namespace ns)</pre>
<div class="block">Constructs a new DOM4J Namespace from the provided StAX Namespace event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ns</code> - The Namespace event from which to construct the new DOM4J
Namespace.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Namespace constructed from the provided Namespace event.</dd></dl>
</li>
</ul>
<a name="createCharacterData(javax.xml.stream.events.Characters)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createCharacterData</h4>
<pre>public <a href="../../../org/dom4j/CharacterData.html" title="interface in org.dom4j">CharacterData</a> createCharacterData(javax.xml.stream.events.Characters characters)</pre>
<div class="block">Constructs a new DOM4J Text or CDATA object from the provided Characters
event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>characters</code> - The Characters event from which to construct the new DOM4J
Text or CDATA object.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Text or CDATA object constructed from the provided Characters
event.</dd></dl>
</li>
</ul>
<a name="createComment(javax.xml.stream.events.Comment)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createComment</h4>
<pre>public <a href="../../../org/dom4j/Comment.html" title="interface in org.dom4j">Comment</a> createComment(javax.xml.stream.events.Comment comment)</pre>
<div class="block">Constructs a new DOM4J Comment from the provided StAX Comment event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comment</code> - The Comment event from which to construct the new DOM4J
Comment.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Comment constructed from the provided Comment event.</dd></dl>
</li>
</ul>
<a name="createEntity(javax.xml.stream.events.EntityReference)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createEntity</h4>
<pre>public <a href="../../../org/dom4j/Entity.html" title="interface in org.dom4j">Entity</a> createEntity(javax.xml.stream.events.EntityReference entityRef)</pre>
<div class="block">Constructs a new DOM4J Entity from the provided StAX EntityReference
event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entityRef</code> - The EntityReference event from which to construct the new
DOM4J Entity.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Entity constructed from the provided EntityReference event.</dd></dl>
</li>
</ul>
<a name="createProcessingInstruction(javax.xml.stream.events.ProcessingInstruction)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createProcessingInstruction</h4>
<pre>public <a href="../../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a> createProcessingInstruction(javax.xml.stream.events.ProcessingInstruction pi)</pre>
<div class="block">Constructs a new DOM4J ProcessingInstruction from the provided StAX
ProcessingInstruction event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pi</code> - The ProcessingInstruction event from which to construct the
new DOM4J ProcessingInstruction.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The ProcessingInstruction constructed from the provided
ProcessingInstruction event.</dd></dl>
</li>
</ul>
<a name="createQName(javax.xml.namespace.QName)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createQName</h4>
<pre>public <a href="../../../org/dom4j/QName.html" title="class in org.dom4j">QName</a> createQName(javax.xml.namespace.QName qname)</pre>
<div class="block">Constructs a new DOM4J QName from the provided JAXP QName.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>qname</code> - The JAXP QName from which to create a DOM4J QName.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The newly constructed DOM4J QName.</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/STAXEventReader.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/SAXWriter.html" title="class in org.dom4j.io"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/dom4j/io/STAXEventWriter.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/STAXEventReader.html" target="_top">Frames</a></li>
<li><a href="STAXEventReader.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>
|