/usr/share/doc/libplexus-utils-java/api/org/codehaus/plexus/util/xml/pull/XmlSerializer.html is in libplexus-utils-java-doc 1:1.5.15-4+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>XmlSerializer (plexus-utils API)</title>
<meta name="date" content="2018-03-19">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="XmlSerializer (plexus-utils API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/codehaus/plexus/util/xml/pull/XmlSerializer.html" target="_top">Frames</a></li>
<li><a href="XmlSerializer.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>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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.codehaus.plexus.util.xml.pull</div>
<h2 title="Interface XmlSerializer" class="title">Interface XmlSerializer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/MXSerializer.html" title="class in org.codehaus.plexus.util.xml.pull">MXSerializer</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">XmlSerializer</span></pre>
<div class="block">Define an interface to serialization of XML Infoset.
This interface abstracts away if serialized XML is XML 1.0 compatible text or
other formats of XML 1.0 serializations (such as binary XML for example with WBXML).
<p><b>PLEASE NOTE:</b> This interface will be part of XmlPull 1.2 API.
It is included as basis for discussion. It may change in any way.
<p>Exceptions that may be thrown are: IOException or runtime exception
(more runtime exceptions can be thrown but are not declared and as such
have no semantics defined for this interface):
<ul>
<li><em>IllegalArgumentException</em> - for almost all methods to signal that
argument is illegal
<li><em>IllegalStateException</em> - to signal that call has good arguments but
is not expected here (violation of contract) and for features/properties
when requesting setting unimplemented feature/property
(UnsupportedOperationException would be better but it is not in MIDP)
</ul>
<p><b>NOTE:</b> writing CDSECT, ENTITY_REF, IGNORABLE_WHITESPACE,
PROCESSING_INSTRUCTION, COMMENT, and DOCDECL in some implementations
may not be supported (for example when serializing to WBXML).
In such case IllegalStateException will be thrown and it is recommended
to use an optional feature to signal that implementation is not
supporting this kind of output.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html" title="interface in org.codehaus.plexus.util.xml.pull">XmlSerializer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#attribute-java.lang.String-java.lang.String-java.lang.String-">attribute</a></span>(java.lang.String namespace,
java.lang.String name,
java.lang.String value)</code>
<div class="block">Write an attribute.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#cdsect-java.lang.String-">cdsect</a></span>(java.lang.String text)</code> </td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#comment-java.lang.String-">comment</a></span>(java.lang.String text)</code> </td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#docdecl-java.lang.String-">docdecl</a></span>(java.lang.String text)</code> </td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#endDocument--">endDocument</a></span>()</code>
<div class="block">Finish writing.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html" title="interface in org.codehaus.plexus.util.xml.pull">XmlSerializer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#endTag-java.lang.String-java.lang.String-">endTag</a></span>(java.lang.String namespace,
java.lang.String name)</code>
<div class="block">Write end tag.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#entityRef-java.lang.String-">entityRef</a></span>(java.lang.String text)</code> </td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#flush--">flush</a></span>()</code>
<div class="block">Write all pending output to the stream.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#getDepth--">getDepth</a></span>()</code>
<div class="block">Returns the current depth of the element.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#getFeature-java.lang.String-">getFeature</a></span>(java.lang.String name)</code>
<div class="block">Return the current value of the feature with given name.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name of the current element as set by startTag().</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#getNamespace--">getNamespace</a></span>()</code>
<div class="block">Returns the namespace URI of the current element as set by startTag().</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#getPrefix-java.lang.String-boolean-">getPrefix</a></span>(java.lang.String namespace,
boolean generatePrefix)</code>
<div class="block">Return namespace that corresponds to given prefix
If there is no prefix bound to this namespace return null
but if generatePrefix is false then return generated prefix.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#getProperty-java.lang.String-">getProperty</a></span>(java.lang.String name)</code>
<div class="block">Look up the value of a property.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#ignorableWhitespace-java.lang.String-">ignorableWhitespace</a></span>(java.lang.String text)</code> </td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#processingInstruction-java.lang.String-">processingInstruction</a></span>(java.lang.String text)</code> </td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#setFeature-java.lang.String-boolean-">setFeature</a></span>(java.lang.String name,
boolean state)</code>
<div class="block">Set feature identified by name (recommended to be URI for uniqueness).</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#setOutput-java.io.OutputStream-java.lang.String-">setOutput</a></span>(java.io.OutputStream os,
java.lang.String encoding)</code>
<div class="block">Set to use binary output stream with given encoding.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#setOutput-java.io.Writer-">setOutput</a></span>(java.io.Writer writer)</code>
<div class="block">Set the output to the given writer.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#setPrefix-java.lang.String-java.lang.String-">setPrefix</a></span>(java.lang.String prefix,
java.lang.String namespace)</code>
<div class="block">Binds the given prefix to the given namespace.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#setProperty-java.lang.String-java.lang.Object-">setProperty</a></span>(java.lang.String name,
java.lang.Object value)</code>
<div class="block">Set the value of a property.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#startDocument-java.lang.String-java.lang.Boolean-">startDocument</a></span>(java.lang.String encoding,
java.lang.Boolean standalone)</code>
<div class="block">Write <?xml declaration with encoding (if encoding not null)
and standalone flag (if standalone not null)
This method can only be called just after setOutput.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html" title="interface in org.codehaus.plexus.util.xml.pull">XmlSerializer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#startTag-java.lang.String-java.lang.String-">startTag</a></span>(java.lang.String namespace,
java.lang.String name)</code>
<div class="block">Writes a start tag with the given namespace and name.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html" title="interface in org.codehaus.plexus.util.xml.pull">XmlSerializer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#text-char:A-int-int-">text</a></span>(char[] buf,
int start,
int len)</code>
<div class="block">Writes text, where special XML chars are escaped automatically</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html" title="interface in org.codehaus.plexus.util.xml.pull">XmlSerializer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html#text-java.lang.String-">text</a></span>(java.lang.String text)</code>
<div class="block">Writes text, where special XML chars are escaped automatically</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setFeature-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFeature</h4>
<pre>void setFeature(java.lang.String name,
boolean state)
throws java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<div class="block">Set feature identified by name (recommended to be URI for uniqueness).
Some well known optional features are defined in
<a href="http://www.xmlpull.org/v1/doc/features.html">
http://www.xmlpull.org/v1/doc/features.html</a>.
If feature is not recognized or can not be set
then IllegalStateException MUST be thrown.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If the feature is not supported or can not be set</dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
</dl>
</li>
</ul>
<a name="getFeature-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFeature</h4>
<pre>boolean getFeature(java.lang.String name)</pre>
<div class="block">Return the current value of the feature with given name.
<p><strong>NOTE:</strong> unknown properties are <strong>always</strong> returned as null</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of feature to be retrieved.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of named feature.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if feature string is null</dd>
</dl>
</li>
</ul>
<a name="setProperty-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>void setProperty(java.lang.String name,
java.lang.Object value)
throws java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<div class="block">Set the value of a property.
(the property name is recommended to be URI for uniqueness).
Some well known optional properties are defined in
<a href="http://www.xmlpull.org/v1/doc/properties.html">
http://www.xmlpull.org/v1/doc/properties.html</a>.
If property is not recognized or can not be set
then IllegalStateException MUST be thrown.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the property is not supported or can not be set</dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
</dl>
</li>
</ul>
<a name="getProperty-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre>java.lang.Object getProperty(java.lang.String name)</pre>
<div class="block">Look up the value of a property.
The property name is any fully-qualified URI. I
<p><strong>NOTE:</strong> unknown properties are <string>always</strong> returned as null</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of property to be retrieved.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of named property.</dd>
</dl>
</li>
</ul>
<a name="setOutput-java.io.OutputStream-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutput</h4>
<pre>void setOutput(java.io.OutputStream os,
java.lang.String encoding)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<div class="block">Set to use binary output stream with given encoding.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="setOutput-java.io.Writer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutput</h4>
<pre>void setOutput(java.io.Writer writer)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<div class="block">Set the output to the given writer.
<p><b>WARNING</b> no information about encoding is available!</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="startDocument-java.lang.String-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startDocument</h4>
<pre>void startDocument(java.lang.String encoding,
java.lang.Boolean standalone)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<div class="block">Write <?xml declaration with encoding (if encoding not null)
and standalone flag (if standalone not null)
This method can only be called just after setOutput.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="endDocument--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endDocument</h4>
<pre>void endDocument()
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<div class="block">Finish writing. All unclosed start tags will be closed and output
will be flushed. After calling this method no more output can be
serialized until next call to setOutput()</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="setPrefix-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPrefix</h4>
<pre>void setPrefix(java.lang.String prefix,
java.lang.String namespace)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<div class="block">Binds the given prefix to the given namespace.
This call is valid for the next element including child elements.
The prefix and namespace MUST be always declared even if prefix
is not used in element (startTag() or attribute()) - for XML 1.0
it must result in declaring <code>xmlns:prefix='namespace'</code>
(or <code>xmlns:prefix="namespace"</code> depending what character is used
to quote attribute value).
<p><b>NOTE:</b> this method MUST be called directly before startTag()
and if anything but startTag() or setPrefix() is called next there will be exception.
<p><b>NOTE:</b> prefixes "xml" and "xmlns" are already bound
and can not be redefined see:
<a href="http://www.w3.org/XML/xml-names-19990114-errata#NE05">Namespaces in XML Errata</a>.
<p><b>NOTE:</b> to set default namespace use as prefix empty string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prefix</code> - must be not null (or IllegalArgumentException is thrown)</dd>
<dd><code>namespace</code> - must be not null</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="getPrefix-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrefix</h4>
<pre>java.lang.String getPrefix(java.lang.String namespace,
boolean generatePrefix)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Return namespace that corresponds to given prefix
If there is no prefix bound to this namespace return null
but if generatePrefix is false then return generated prefix.
<p><b>NOTE:</b> if the prefix is empty string "" and default namespace is bound
to this prefix then empty string ("") is returned.
<p><b>NOTE:</b> prefixes "xml" and "xmlns" are already bound
will have values as defined
<a href="http://www.w3.org/TR/REC-xml-names/">Namespaces in XML specification</a></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code></dd>
</dl>
</li>
</ul>
<a name="getDepth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDepth</h4>
<pre>int getDepth()</pre>
<div class="block">Returns the current depth of the element.
Outside the root element, the depth is 0. The
depth is incremented by 1 when startTag() is called.
The depth is decremented after the call to endTag()
event was observed.
<pre>
<!-- outside --> 0
<root> 1
sometext 1
<foobar> 2
</foobar> 2
</root> 1
<!-- outside --> 0
</pre></div>
</li>
</ul>
<a name="getNamespace--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespace</h4>
<pre>java.lang.String getNamespace()</pre>
<div class="block">Returns the namespace URI of the current element as set by startTag().
<p><b>NOTE:</b> that means in particular that: <ul>
<li>if there was startTag("", ...) then getNamespace() returns ""
<li>if there was startTag(null, ...) then getNamespace() returns null
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>namespace set by startTag() that is currently in scope</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String getName()</pre>
<div class="block">Returns the name of the current element as set by startTag().
It can only be null before first call to startTag()
or when last endTag() is called to close first startTag().</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>namespace set by startTag() that is currently in scope</dd>
</dl>
</li>
</ul>
<a name="startTag-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startTag</h4>
<pre><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html" title="interface in org.codehaus.plexus.util.xml.pull">XmlSerializer</a> startTag(java.lang.String namespace,
java.lang.String name)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<div class="block">Writes a start tag with the given namespace and name.
If there is no prefix defined for the given namespace,
a prefix will be defined automatically.
The explicit prefixes for namespaces can be established by calling setPrefix()
immediately before this method.
If namespace is null no namespace prefix is printed but just name.
If namespace is empty string then serializer will make sure that
default empty namespace is declared (in XML 1.0 xmlns='')
or throw IllegalStateException if default namespace is already bound
to non-empty string.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="attribute-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>attribute</h4>
<pre><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html" title="interface in org.codehaus.plexus.util.xml.pull">XmlSerializer</a> attribute(java.lang.String namespace,
java.lang.String name,
java.lang.String value)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<div class="block">Write an attribute. Calls to attribute() MUST follow a call to
startTag() immediately. If there is no prefix defined for the
given namespace, a prefix will be defined automatically.
If namespace is null or empty string
no namespace prefix is printed but just name.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="endTag-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endTag</h4>
<pre><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html" title="interface in org.codehaus.plexus.util.xml.pull">XmlSerializer</a> endTag(java.lang.String namespace,
java.lang.String name)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<div class="block">Write end tag. Repetition of namespace and name is just for avoiding errors.
<p><b>Background:</b> in kXML endTag had no arguments, and non matching tags were
very difficult to find...
If namespace is null no namespace prefix is printed but just name.
If namespace is empty string then serializer will make sure that
default empty namespace is declared (in XML 1.0 xmlns='').</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="text-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>text</h4>
<pre><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html" title="interface in org.codehaus.plexus.util.xml.pull">XmlSerializer</a> text(java.lang.String text)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<div class="block">Writes text, where special XML chars are escaped automatically</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="text-char:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>text</h4>
<pre><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlSerializer.html" title="interface in org.codehaus.plexus.util.xml.pull">XmlSerializer</a> text(char[] buf,
int start,
int len)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<div class="block">Writes text, where special XML chars are escaped automatically</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="cdsect-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cdsect</h4>
<pre>void cdsect(java.lang.String text)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="entityRef-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entityRef</h4>
<pre>void entityRef(java.lang.String text)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="processingInstruction-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processingInstruction</h4>
<pre>void processingInstruction(java.lang.String text)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="comment-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>comment</h4>
<pre>void comment(java.lang.String text)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="docdecl-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>docdecl</h4>
<pre>void docdecl(java.lang.String text)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="ignorableWhitespace-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ignorableWhitespace</h4>
<pre>void ignorableWhitespace(java.lang.String text)
throws java.io.IOException,
java.lang.IllegalArgumentException,
java.lang.IllegalStateException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="flush--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>flush</h4>
<pre>void flush()
throws java.io.IOException</pre>
<div class="block">Write all pending output to the stream.
If method startTag() or attribute() was called then start tag is closed (final >)
before flush() is called on underlying output stream.
<p><b>NOTE:</b> if there is need to close start tag
(so no more attribute() calls are allowed) but without flushing output
call method text() with empty string (text("")).</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/codehaus/plexus/util/xml/pull/XmlSerializer.html" target="_top">Frames</a></li>
<li><a href="XmlSerializer.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>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|