/usr/share/doc/libstax-java-doc/api/com/bea/xml/stream/events/BaseEvent.html is in libstax-java-doc 1.2.0-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 | <!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_03) on Fri May 18 11:56:31 UTC 2012 -->
<title>BaseEvent (${ProjectName})</title>
<meta name="date" content="2012-05-18">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BaseEvent (${ProjectName})";
}
//-->
</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="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../com/bea/xml/stream/events/CharactersEvent.html" title="class in com.bea.xml.stream.events"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/bea/xml/stream/events/BaseEvent.html" target="_top">Frames</a></li>
<li><a href="BaseEvent.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">com.bea.xml.stream.events</div>
<h2 title="Class BaseEvent" class="title">Class BaseEvent</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.bea.xml.stream.events.BaseEvent</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>javax.xml.stream.events.XMLEvent, javax.xml.stream.Location, javax.xml.stream.XMLStreamConstants</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../com/bea/xml/stream/events/CharactersEvent.html" title="class in com.bea.xml.stream.events">CharactersEvent</a>, <a href="../../../../../com/bea/xml/stream/events/DTDEvent.html" title="class in com.bea.xml.stream.events">DTDEvent</a>, <a href="../../../../../com/bea/xml/stream/events/EndDocumentEvent.html" title="class in com.bea.xml.stream.events">EndDocumentEvent</a>, <a href="../../../../../com/bea/xml/stream/events/EntityDeclarationEvent.html" title="class in com.bea.xml.stream.events">EntityDeclarationEvent</a>, <a href="../../../../../com/bea/xml/stream/events/EntityReferenceEvent.html" title="class in com.bea.xml.stream.events">EntityReferenceEvent</a>, <a href="../../../../../com/bea/xml/stream/events/NamedEvent.html" title="class in com.bea.xml.stream.events">NamedEvent</a>, <a href="../../../../../com/bea/xml/stream/events/NotationDeclarationEvent.html" title="class in com.bea.xml.stream.events">NotationDeclarationEvent</a>, <a href="../../../../../com/bea/xml/stream/events/ProcessingInstructionEvent.html" title="class in com.bea.xml.stream.events">ProcessingInstructionEvent</a>, <a href="../../../../../com/bea/xml/stream/events/StartDocumentEvent.html" title="class in com.bea.xml.stream.events">StartDocumentEvent</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">BaseEvent</span>
extends java.lang.Object
implements javax.xml.stream.events.XMLEvent, javax.xml.stream.Location</pre>
<div class="block"><p> Base event class for events to extend from </p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_javax.xml.stream.XMLStreamConstants">
<!-- -->
</a>
<h3>Fields inherited from interface javax.xml.stream.XMLStreamConstants</h3>
<code>ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#BaseEvent()">BaseEvent</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#BaseEvent(int)">BaseEvent</a></strong>(int type)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>javax.xml.stream.events.Characters</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#asCharacters()">asCharacters</a></strong>()</code>
<div class="block">Returns this event as Characters, may result in
a class cast exception if this event is not Characters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>javax.xml.stream.events.EndElement</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#asEndElement()">asEndElement</a></strong>()</code>
<div class="block">Returns this event as an end element event, may result in
a class cast exception if this event is not a end element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>javax.xml.stream.events.StartElement</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#asStartElement()">asStartElement</a></strong>()</code>
<div class="block">Returns this event as a start element event, may result in
a class cast exception if this event is not a start element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#doWriteAsEncodedUnicode(java.io.Writer)">doWriteAsEncodedUnicode</a></strong>(java.io.Writer writer)</code>
<div class="block">Template method to be implemented by sub-classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#getCharacterOffset()">getCharacterOffset</a></strong>()</code>
<div class="block">Return the byte or character offset into the input source this location
is pointing to.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#getColumnNumber()">getColumnNumber</a></strong>()</code>
<div class="block">Return the column number where the current event ends,
returns -1 if none is available.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#getEventType()">getEventType</a></strong>()</code>
<div class="block">Returns an integer code for this event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#getLineNumber()">getLineNumber</a></strong>()</code>
<div class="block">Return the line number where the current event ends,
returns -1 if none is available.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>javax.xml.stream.Location</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#getLocation()">getLocation</a></strong>()</code>
<div class="block">Return the location of this event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#getLocationURI()">getLocationURI</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#getPublicId()">getPublicId</a></strong>()</code>
<div class="block">Returns the public ID of the XML</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>javax.xml.namespace.QName</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#getSchemaType()">getSchemaType</a></strong>()</code>
<div class="block">This method is provided for implementations to provide
optional type information about the associated event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#getSourceName()">getSourceName</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#getSystemId()">getSystemId</a></strong>()</code>
<div class="block">Returns the system ID of the XML</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#getTypeAsString()">getTypeAsString</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#isAttribute()">isAttribute</a></strong>()</code>
<div class="block">A utility function to check if this event is an Attribute.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#isCharacters()">isCharacters</a></strong>()</code>
<div class="block">A utility function to check if this event is Characters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#isEndDocument()">isEndDocument</a></strong>()</code>
<div class="block">A utility function to check if this event is an EndDocument.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#isEndElement()">isEndElement</a></strong>()</code>
<div class="block">A utility function to check if this event is a EndElement.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#isEntityReference()">isEntityReference</a></strong>()</code>
<div class="block">A utility function to check if this event is an EntityReference.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#isNamespace()">isNamespace</a></strong>()</code>
<div class="block">A utility function to check if this event is a Namespace.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#isProcessingInstruction()">isProcessingInstruction</a></strong>()</code>
<div class="block">A utility function to check if this event is a ProcessingInstruction.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#isStartDocument()">isStartDocument</a></strong>()</code>
<div class="block">A utility function to check if this event is a StartDocument.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#isStartElement()">isStartElement</a></strong>()</code>
<div class="block">A utility function to check if this event is a StartElement.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#recycle()">recycle</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#setCharacterOffset(int)">setCharacterOffset</a></strong>(int c)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#setColumnNumber(int)">setColumnNumber</a></strong>(int col)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#setEventType(int)">setEventType</a></strong>(int type)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#setLineNumber(int)">setLineNumber</a></strong>(int line)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#setLocationURI(java.lang.String)">setLocationURI</a></strong>(java.lang.String uri)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#toString()">toString</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/bea/xml/stream/events/BaseEvent.html#writeAsEncodedUnicode(java.io.Writer)">writeAsEncodedUnicode</a></strong>(java.io.Writer writer)</code>
<div class="block">This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.</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, 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="BaseEvent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BaseEvent</h4>
<pre>public BaseEvent()</pre>
</li>
</ul>
<a name="BaseEvent(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BaseEvent</h4>
<pre>public BaseEvent(int type)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getEventType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventType</h4>
<pre>public int getEventType()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">Returns an integer code for this event.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getEventType</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>XMLStreamConstants.START_ELEMENT</code>,
<code>XMLStreamConstants.END_ELEMENT</code>,
<code>XMLStreamConstants.CHARACTERS</code>,
<code>XMLStreamConstants.ATTRIBUTE</code>,
<code>XMLStreamConstants.NAMESPACE</code>,
<code>XMLStreamConstants.PROCESSING_INSTRUCTION</code>,
<code>XMLStreamConstants.COMMENT</code>,
<code>XMLStreamConstants.START_DOCUMENT</code>,
<code>XMLStreamConstants.END_DOCUMENT</code>,
<code>XMLStreamConstants.DTD</code></dd></dl>
</li>
</ul>
<a name="setEventType(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEventType</h4>
<pre>protected void setEventType(int type)</pre>
</li>
</ul>
<a name="getTypeAsString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeAsString</h4>
<pre>public java.lang.String getTypeAsString()</pre>
</li>
</ul>
<a name="isStartElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStartElement</h4>
<pre>public boolean isStartElement()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">A utility function to check if this event is a StartElement.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>isStartElement</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>StartElement</code></dd></dl>
</li>
</ul>
<a name="isEndElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEndElement</h4>
<pre>public boolean isEndElement()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">A utility function to check if this event is a EndElement.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>isEndElement</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>EndElement</code></dd></dl>
</li>
</ul>
<a name="isEntityReference()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEntityReference</h4>
<pre>public boolean isEntityReference()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">A utility function to check if this event is an EntityReference.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>isEntityReference</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>EntityReference</code></dd></dl>
</li>
</ul>
<a name="isProcessingInstruction()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isProcessingInstruction</h4>
<pre>public boolean isProcessingInstruction()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">A utility function to check if this event is a ProcessingInstruction.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>isProcessingInstruction</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>ProcessingInstruction</code></dd></dl>
</li>
</ul>
<a name="isCharacters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCharacters</h4>
<pre>public boolean isCharacters()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">A utility function to check if this event is Characters.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>isCharacters</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>Characters</code></dd></dl>
</li>
</ul>
<a name="isStartDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStartDocument</h4>
<pre>public boolean isStartDocument()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">A utility function to check if this event is a StartDocument.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>isStartDocument</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>StartDocument</code></dd></dl>
</li>
</ul>
<a name="isEndDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEndDocument</h4>
<pre>public boolean isEndDocument()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">A utility function to check if this event is an EndDocument.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>isEndDocument</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>EndDocument</code></dd></dl>
</li>
</ul>
<a name="isAttribute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAttribute</h4>
<pre>public boolean isAttribute()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">A utility function to check if this event is an Attribute.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>isAttribute</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>Attribute</code></dd></dl>
</li>
</ul>
<a name="isNamespace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNamespace</h4>
<pre>public boolean isNamespace()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">A utility function to check if this event is a Namespace.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>isNamespace</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>Namespace</code></dd></dl>
</li>
</ul>
<a name="getLocation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocation</h4>
<pre>public javax.xml.stream.Location getLocation()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">Return the location of this event. The Location
returned from this method is non-volatile and
will retain its information.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getLocation</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>Location</code></dd></dl>
</li>
</ul>
<a name="getPublicId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPublicId</h4>
<pre>public java.lang.String getPublicId()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.Location</code></strong></div>
<div class="block">Returns the public ID of the XML</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getPublicId</code> in interface <code>javax.xml.stream.Location</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the public ID, or null if not available</dd></dl>
</li>
</ul>
<a name="getSystemId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSystemId</h4>
<pre>public java.lang.String getSystemId()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.Location</code></strong></div>
<div class="block">Returns the system ID of the XML</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getSystemId</code> in interface <code>javax.xml.stream.Location</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the system ID, or null if not available</dd></dl>
</li>
</ul>
<a name="getSourceName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceName</h4>
<pre>public java.lang.String getSourceName()</pre>
</li>
</ul>
<a name="getLineNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLineNumber</h4>
<pre>public int getLineNumber()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.Location</code></strong></div>
<div class="block">Return the line number where the current event ends,
returns -1 if none is available.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getLineNumber</code> in interface <code>javax.xml.stream.Location</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the current line number</dd></dl>
</li>
</ul>
<a name="setLineNumber(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLineNumber</h4>
<pre>public void setLineNumber(int line)</pre>
</li>
</ul>
<a name="getColumnNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnNumber</h4>
<pre>public int getColumnNumber()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.Location</code></strong></div>
<div class="block">Return the column number where the current event ends,
returns -1 if none is available.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getColumnNumber</code> in interface <code>javax.xml.stream.Location</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the current column number</dd></dl>
</li>
</ul>
<a name="setColumnNumber(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumnNumber</h4>
<pre>public void setColumnNumber(int col)</pre>
</li>
</ul>
<a name="getCharacterOffset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharacterOffset</h4>
<pre>public int getCharacterOffset()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.Location</code></strong></div>
<div class="block">Return the byte or character offset into the input source this location
is pointing to. If the input source is a file or a byte stream then
this is the byte offset into that stream, but if the input source is
a character media then the offset is the character offset.
Returns -1 if there is no offset available.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getCharacterOffset</code> in interface <code>javax.xml.stream.Location</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the current offset</dd></dl>
</li>
</ul>
<a name="setCharacterOffset(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCharacterOffset</h4>
<pre>public void setCharacterOffset(int c)</pre>
</li>
</ul>
<a name="getLocationURI()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocationURI</h4>
<pre>public java.lang.String getLocationURI()</pre>
</li>
</ul>
<a name="setLocationURI(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocationURI</h4>
<pre>public void setLocationURI(java.lang.String uri)</pre>
</li>
</ul>
<a name="asStartElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asStartElement</h4>
<pre>public javax.xml.stream.events.StartElement asStartElement()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">Returns this event as a start element event, may result in
a class cast exception if this event is not a start element.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>asStartElement</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
</dl>
</li>
</ul>
<a name="asEndElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asEndElement</h4>
<pre>public javax.xml.stream.events.EndElement asEndElement()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">Returns this event as an end element event, may result in
a class cast exception if this event is not a end element.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>asEndElement</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
</dl>
</li>
</ul>
<a name="asCharacters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asCharacters</h4>
<pre>public javax.xml.stream.events.Characters asCharacters()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">Returns this event as Characters, may result in
a class cast exception if this event is not Characters.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>asCharacters</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
</dl>
</li>
</ul>
<a name="recycle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recycle</h4>
<pre>public void recycle()</pre>
</li>
</ul>
<a name="getSchemaType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchemaType</h4>
<pre>public javax.xml.namespace.QName getSchemaType()</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">This method is provided for implementations to provide
optional type information about the associated event.
It is optional and will return null if no information
is available.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getSchemaType</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
</dl>
</li>
</ul>
<a name="writeAsEncodedUnicode(java.io.Writer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeAsEncodedUnicode</h4>
<pre>public final void writeAsEncodedUnicode(java.io.Writer writer)
throws javax.xml.stream.XMLStreamException</pre>
<div class="block"><strong>Description copied from interface: <code>javax.xml.stream.events.XMLEvent</code></strong></div>
<div class="block">This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
No indentation or whitespace should be outputted.
Any user defined event type SHALL have this method
called when being written to on an output stream.
Built in Event types MUST implement this method,
but implementations MAY choose not call these methods
for optimizations reasons when writing out built in
Events to an output stream.
The output generated MUST be equivalent in terms of the
infoset expressed.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>writeAsEncodedUnicode</code> in interface <code>javax.xml.stream.events.XMLEvent</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>writer</code> - The writer that will output the data</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>XMLStreamException</code> - if there is a fatal error writing the event</dd></dl>
</li>
</ul>
<a name="doWriteAsEncodedUnicode(java.io.Writer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doWriteAsEncodedUnicode</h4>
<pre>protected abstract void doWriteAsEncodedUnicode(java.io.Writer writer)
throws java.io.IOException,
javax.xml.stream.XMLStreamException</pre>
<div class="block">Template method to be implemented by sub-classes.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>javax.xml.stream.XMLStreamException</code></dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></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="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../com/bea/xml/stream/events/CharactersEvent.html" title="class in com.bea.xml.stream.events"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/bea/xml/stream/events/BaseEvent.html" target="_top">Frames</a></li>
<li><a href="BaseEvent.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 ======= -->
</body>
</html>
|