/usr/share/doc/libjenkins-dom4j-java/api/org/dom4j/io/OutputFormat.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 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 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 | <!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>OutputFormat (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="OutputFormat (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/OutputFormat.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/HTMLWriter.html" title="class in org.dom4j.io"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/dom4j/io/SAXContentHandler.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/OutputFormat.html" target="_top">Frames</a></li>
<li><a href="OutputFormat.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 OutputFormat" class="title">Class OutputFormat</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.dom4j.io.OutputFormat</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">OutputFormat</span>
extends java.lang.Object
implements java.lang.Cloneable</pre>
<div class="block"><p>
<code>OutputFormat</code> represents the format configuration used by
and its base classes to format the XML output
</p></div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.17 $</dd>
<dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:james.strachan@metastuff.com">James Strachan </a></dd></dl>
</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>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#STANDARD_INDENT">STANDARD_INDENT</a></strong></code>
<div class="block">standard value to indent by, if we are indenting</div>
</td>
</tr>
</table>
</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="../../../org/dom4j/io/OutputFormat.html#OutputFormat()">OutputFormat</a></strong>()</code>
<div class="block">Creates an <code>OutputFormat</code> with no additional whitespace
(indent or new lines) added.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#OutputFormat(java.lang.String)">OutputFormat</a></strong>(java.lang.String indent)</code>
<div class="block">Creates an <code>OutputFormat</code> with the given indent added but no
new lines added.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#OutputFormat(java.lang.String,%20boolean)">OutputFormat</a></strong>(java.lang.String indent,
boolean newlines)</code>
<div class="block">Creates an <code>OutputFormat</code> with the given indent added with
optional newlines between the Elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#OutputFormat(java.lang.String,%20boolean,%20java.lang.String)">OutputFormat</a></strong>(java.lang.String indent,
boolean newlines,
java.lang.String encoding)</code>
<div class="block">Creates an <code>OutputFormat</code> with the given indent added with
optional newlines between the Elements and the given encoding format.</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>static <a href="../../../org/dom4j/io/OutputFormat.html" title="class in org.dom4j.io">OutputFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#createCompactFormat()">createCompactFormat</a></strong>()</code>
<div class="block">A static helper method to create the default compact format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/dom4j/io/OutputFormat.html" title="class in org.dom4j.io">OutputFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#createPrettyPrint()">createPrettyPrint</a></strong>()</code>
<div class="block">A static helper method to create the default pretty printing format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>char</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#getAttributeQuoteCharacter()">getAttributeQuoteCharacter</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#getEncoding()">getEncoding</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#getIndent()">getIndent</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#getLineSeparator()">getLineSeparator</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#getNewLineAfterNTags()">getNewLineAfterNTags</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#isExpandEmptyElements()">isExpandEmptyElements</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#isNewLineAfterDeclaration()">isNewLineAfterDeclaration</a></strong>()</code>
<div class="block">DOCUMENT ME!</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#isNewlines()">isNewlines</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#isOmitEncoding()">isOmitEncoding</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#isPadText()">isPadText</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#isSuppressDeclaration()">isSuppressDeclaration</a></strong>()</code>
<div class="block">DOCUMENT ME!</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#isTrimText()">isTrimText</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#isXHTML()">isXHTML</a></strong>()</code>
<div class="block">
Whether or not to use the XHTML standard: like HTML but passes an XML
parser with real, closed tags.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#parseOptions(java.lang.String[],%20int)">parseOptions</a></strong>(java.lang.String[] args,
int i)</code>
<div class="block">Parses command line arguments of the form <code>-omitEncoding
-indentSize 3 -newlines -trimText</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setAttributeQuoteCharacter(char)">setAttributeQuoteCharacter</a></strong>(char quoteChar)</code>
<div class="block">Sets the character used to quote attribute values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setEncoding(java.lang.String)">setEncoding</a></strong>(java.lang.String encoding)</code>
<div class="block">DOCUMENT ME!</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setExpandEmptyElements(boolean)">setExpandEmptyElements</a></strong>(boolean expandEmptyElements)</code>
<div class="block">
This will set whether empty elements are expanded from
<code><tagName></code> to
<code><tagName></tagName></code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setIndent(boolean)">setIndent</a></strong>(boolean doIndent)</code>
<div class="block">Set the indent on or off.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setIndent(java.lang.String)">setIndent</a></strong>(java.lang.String indent)</code>
<div class="block">
This will set the indent <code>String</code> to use; this is usually a
<code>String</code> of empty spaces.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setIndentSize(int)">setIndentSize</a></strong>(int indentSize)</code>
<div class="block">
This will set the indent <code>String</code>'s size; an indentSize of
4 would result in the indention being equivalent to the
<code>String</code> " " (four space characters).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setLineSeparator(java.lang.String)">setLineSeparator</a></strong>(java.lang.String separator)</code>
<div class="block">
This will set the new-line separator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setNewLineAfterDeclaration(boolean)">setNewLineAfterDeclaration</a></strong>(boolean newLineAfterDeclaration)</code>
<div class="block">
This will set whether a new line is printed after the XML declaration
(assuming it is not supressed.)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setNewLineAfterNTags(int)">setNewLineAfterNTags</a></strong>(int tagCount)</code>
<div class="block">Controls output of a line.separator every tagCount tags when isNewlines
is false.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setNewlines(boolean)">setNewlines</a></strong>(boolean newlines)</code>
<div class="block">DOCUMENT ME!</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setOmitEncoding(boolean)">setOmitEncoding</a></strong>(boolean omitEncoding)</code>
<div class="block">
This will set whether the XML declaration (<code><?xml version="1.0"
encoding="UTF-8"?></code>)
includes the encoding of the document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setPadText(boolean)">setPadText</a></strong>(boolean padText)</code>
<div class="block">
Ensure that text immediately preceded by or followed by an element will
be "padded" with a single space.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setSuppressDeclaration(boolean)">setSuppressDeclaration</a></strong>(boolean suppressDeclaration)</code>
<div class="block">
This will set whether the XML declaration (<code><?xml version="1.0"
encoding="UTF-8"?></code>)
is included or not.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setTrimText(boolean)">setTrimText</a></strong>(boolean trimText)</code>
<div class="block">
This will set whether the text is output verbatim (false) or with
whitespace stripped as per <code><a href="../../../org/dom4j/Element.html#getTextTrim()"><code>Element.getTextTrim()</code></a></code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/dom4j/io/OutputFormat.html#setXHTML(boolean)">setXHTML</a></strong>(boolean xhtml)</code>
<div class="block">
This will set whether or not to use the XHTML standard: like HTML but
passes an XML parser with real, closed tags.</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="STANDARD_INDENT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>STANDARD_INDENT</h4>
<pre>protected static final java.lang.String STANDARD_INDENT</pre>
<div class="block">standard value to indent by, if we are indenting</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.dom4j.io.OutputFormat.STANDARD_INDENT">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="OutputFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OutputFormat</h4>
<pre>public OutputFormat()</pre>
<div class="block">Creates an <code>OutputFormat</code> with no additional whitespace
(indent or new lines) added. The whitespace from the element text content
is fully preserved.</div>
</li>
</ul>
<a name="OutputFormat(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OutputFormat</h4>
<pre>public OutputFormat(java.lang.String indent)</pre>
<div class="block">Creates an <code>OutputFormat</code> with the given indent added but no
new lines added. All whitespace from element text will be included.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indent</code> - is the indent string to be used for indentation (usually a
number of spaces).</dd></dl>
</li>
</ul>
<a name="OutputFormat(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OutputFormat</h4>
<pre>public OutputFormat(java.lang.String indent,
boolean newlines)</pre>
<div class="block">Creates an <code>OutputFormat</code> with the given indent added with
optional newlines between the Elements. All whitespace from element text
will be included.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indent</code> - is the indent string to be used for indentation (usually a
number of spaces).</dd><dd><code>newlines</code> - whether new lines are added to layout the</dd></dl>
</li>
</ul>
<a name="OutputFormat(java.lang.String, boolean, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OutputFormat</h4>
<pre>public OutputFormat(java.lang.String indent,
boolean newlines,
java.lang.String encoding)</pre>
<div class="block">Creates an <code>OutputFormat</code> with the given indent added with
optional newlines between the Elements and the given encoding format.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indent</code> - is the indent string to be used for indentation (usually a
number of spaces).</dd><dd><code>newlines</code> - whether new lines are added to layout the</dd><dd><code>encoding</code> - is the text encoding to use for writing the XML</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="getLineSeparator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLineSeparator</h4>
<pre>public java.lang.String getLineSeparator()</pre>
</li>
</ul>
<a name="setLineSeparator(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLineSeparator</h4>
<pre>public void setLineSeparator(java.lang.String separator)</pre>
<div class="block"><p>
This will set the new-line separator. The default is <code>\n</code>.
Note that if the "newlines" property is false, this value is irrelevant.
To make it output the system default line ending string, call
<code>setLineSeparator(System.getProperty("line.separator"))</code>
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>separator</code> - <code>String</code> line separator to use.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/dom4j/io/OutputFormat.html#setNewlines(boolean)"><code>setNewlines(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="isNewlines()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNewlines</h4>
<pre>public boolean isNewlines()</pre>
</li>
</ul>
<a name="setNewlines(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNewlines</h4>
<pre>public void setNewlines(boolean newlines)</pre>
<div class="block">DOCUMENT ME!</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newlines</code> - <code>true</code> indicates new lines should be printed,
else new lines are ignored (compacted).</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/dom4j/io/OutputFormat.html#setLineSeparator(java.lang.String)"><code>setLineSeparator(String)</code></a></dd></dl>
</li>
</ul>
<a name="getEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncoding</h4>
<pre>public java.lang.String getEncoding()</pre>
</li>
</ul>
<a name="setEncoding(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEncoding</h4>
<pre>public void setEncoding(java.lang.String encoding)</pre>
<div class="block">DOCUMENT ME!</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>encoding</code> - encoding format</dd></dl>
</li>
</ul>
<a name="isOmitEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOmitEncoding</h4>
<pre>public boolean isOmitEncoding()</pre>
</li>
</ul>
<a name="setOmitEncoding(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOmitEncoding</h4>
<pre>public void setOmitEncoding(boolean omitEncoding)</pre>
<div class="block"><p>
This will set whether the XML declaration (<code><?xml version="1.0"
encoding="UTF-8"?></code>)
includes the encoding of the document. It is common to suppress this in
protocols such as WML and SOAP.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>omitEncoding</code> - <code>boolean</code> indicating whether or not the XML
declaration should indicate the document encoding.</dd></dl>
</li>
</ul>
<a name="setSuppressDeclaration(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSuppressDeclaration</h4>
<pre>public void setSuppressDeclaration(boolean suppressDeclaration)</pre>
<div class="block"><p>
This will set whether the XML declaration (<code><?xml version="1.0"
encoding="UTF-8"?></code>)
is included or not. It is common to suppress this in protocols such as
WML and SOAP.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>suppressDeclaration</code> - <code>boolean</code> indicating whether or not the XML
declaration should be suppressed.</dd></dl>
</li>
</ul>
<a name="isSuppressDeclaration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSuppressDeclaration</h4>
<pre>public boolean isSuppressDeclaration()</pre>
<div class="block">DOCUMENT ME!</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the output of the XML declaration (<code><?xml
version="1.0"?></code>)
should be suppressed else false.</dd></dl>
</li>
</ul>
<a name="setNewLineAfterDeclaration(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNewLineAfterDeclaration</h4>
<pre>public void setNewLineAfterDeclaration(boolean newLineAfterDeclaration)</pre>
<div class="block"><p>
This will set whether a new line is printed after the XML declaration
(assuming it is not supressed.)
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newLineAfterDeclaration</code> - <code>boolean</code> indicating whether or not to print new
line following the XML declaration. The default is true.</dd></dl>
</li>
</ul>
<a name="isNewLineAfterDeclaration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNewLineAfterDeclaration</h4>
<pre>public boolean isNewLineAfterDeclaration()</pre>
<div class="block">DOCUMENT ME!</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if a new line should be printed following XML declaration</dd></dl>
</li>
</ul>
<a name="isExpandEmptyElements()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExpandEmptyElements</h4>
<pre>public boolean isExpandEmptyElements()</pre>
</li>
</ul>
<a name="setExpandEmptyElements(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExpandEmptyElements</h4>
<pre>public void setExpandEmptyElements(boolean expandEmptyElements)</pre>
<div class="block"><p>
This will set whether empty elements are expanded from
<code><tagName></code> to
<code><tagName></tagName></code>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expandEmptyElements</code> - <code>boolean</code> indicating whether or not empty
elements should be expanded.</dd></dl>
</li>
</ul>
<a name="isTrimText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTrimText</h4>
<pre>public boolean isTrimText()</pre>
</li>
</ul>
<a name="setTrimText(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrimText</h4>
<pre>public void setTrimText(boolean trimText)</pre>
<div class="block"><p>
This will set whether the text is output verbatim (false) or with
whitespace stripped as per <code><a href="../../../org/dom4j/Element.html#getTextTrim()"><code>Element.getTextTrim()</code></a></code>.
</p>
<p>
</p>
<p>
Default: false
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>trimText</code> - <code>boolean</code> true=>trim the whitespace, false=>use
text verbatim</dd></dl>
</li>
</ul>
<a name="isPadText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPadText</h4>
<pre>public boolean isPadText()</pre>
</li>
</ul>
<a name="setPadText(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPadText</h4>
<pre>public void setPadText(boolean padText)</pre>
<div class="block"><p>
Ensure that text immediately preceded by or followed by an element will
be "padded" with a single space. This is used to allow make
browser-friendly HTML, avoiding trimText's transformation of, e.g.,
<code>The quick <b>brown</b> fox</code> into <code>The
quick<b>brown</b>fox</code>
(the latter will run the three separate words together into a single
word). This setting is not too useful if you haven't also called
<a href="../../../org/dom4j/io/OutputFormat.html#setTrimText(boolean)"><code>setTrimText(boolean)</code></a>.
</p>
<p>
The padding string will only be added if the text itself starts or ends
with some whitespace characters.
</p>
<p>
Default: false
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>padText</code> - <code>boolean</code> if true, pad string-element boundaries</dd></dl>
</li>
</ul>
<a name="getIndent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndent</h4>
<pre>public java.lang.String getIndent()</pre>
</li>
</ul>
<a name="setIndent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndent</h4>
<pre>public void setIndent(java.lang.String indent)</pre>
<div class="block"><p>
This will set the indent <code>String</code> to use; this is usually a
<code>String</code> of empty spaces. If you pass null, or the empty
string (""), then no indentation will happen.
</p>
Default: none (null)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indent</code> - <code>String</code> to use for indentation.</dd></dl>
</li>
</ul>
<a name="setIndent(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndent</h4>
<pre>public void setIndent(boolean doIndent)</pre>
<div class="block">Set the indent on or off. If setting on, will use the value of
STANDARD_INDENT, which is usually two spaces.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>doIndent</code> - if true, set indenting on; if false, set indenting off</dd></dl>
</li>
</ul>
<a name="setIndentSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndentSize</h4>
<pre>public void setIndentSize(int indentSize)</pre>
<div class="block"><p>
This will set the indent <code>String</code>'s size; an indentSize of
4 would result in the indention being equivalent to the
<code>String</code> " " (four space characters).
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indentSize</code> - <code>int</code> number of spaces in indentation.</dd></dl>
</li>
</ul>
<a name="isXHTML()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isXHTML</h4>
<pre>public boolean isXHTML()</pre>
<div class="block"><p>
Whether or not to use the XHTML standard: like HTML but passes an XML
parser with real, closed tags. Also, XHTML CDATA sections will be output
with the CDATA delimiters: ( " <b><![CDATA[ </b>" and "
<b>]]> </b>" ) otherwise, the class HTMLWriter will output the
CDATA text, but not the delimiters.
</p>
<p>
Default is <code>false</code>
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="setXHTML(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setXHTML</h4>
<pre>public void setXHTML(boolean xhtml)</pre>
<div class="block"><p>
This will set whether or not to use the XHTML standard: like HTML but
passes an XML parser with real, closed tags. Also, XHTML CDATA sections
will be output with the CDATA delimiters: ( " <b><[CDATA[
</b>" and " <b>]]< </b>) otherwise, the class HTMLWriter
will output the CDATA text, but not the delimiters.
</p>
<p>
Default: false
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xhtml</code> - <code>boolean</code> true=>conform to XHTML, false=>conform
to HTML, can have unclosed tags, etc.</dd></dl>
</li>
</ul>
<a name="getNewLineAfterNTags()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNewLineAfterNTags</h4>
<pre>public int getNewLineAfterNTags()</pre>
</li>
</ul>
<a name="setNewLineAfterNTags(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNewLineAfterNTags</h4>
<pre>public void setNewLineAfterNTags(int tagCount)</pre>
<div class="block">Controls output of a line.separator every tagCount tags when isNewlines
is false. If tagCount equals zero, it means don't do anything special. If
greater than zero, then a line.separator will be output after tagCount
tags have been output. Used when you would like to squeeze the html as
much as possible, but some browsers don't like really long lines. A tag
count of 10 would produce a line.separator in the output after 10 close
tags (including single tags).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tagCount</code> - DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="getAttributeQuoteCharacter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeQuoteCharacter</h4>
<pre>public char getAttributeQuoteCharacter()</pre>
</li>
</ul>
<a name="setAttributeQuoteCharacter(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttributeQuoteCharacter</h4>
<pre>public void setAttributeQuoteCharacter(char quoteChar)</pre>
<div class="block">Sets the character used to quote attribute values. The specified
character must be a valid XML attribute quote character, otherwise an
<code>IllegalArgumentException</code> will be thrown.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>quoteChar</code> - The character to use when quoting attribute values.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If the specified character is not a valid XML attribute quote
character.</dd></dl>
</li>
</ul>
<a name="parseOptions(java.lang.String[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseOptions</h4>
<pre>public int parseOptions(java.lang.String[] args,
int i)</pre>
<div class="block">Parses command line arguments of the form <code>-omitEncoding
-indentSize 3 -newlines -trimText</code></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - is the array of command line arguments</dd><dd><code>i</code> - is the index in args to start parsing options</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index of first parameter that we didn't understand</dd></dl>
</li>
</ul>
<a name="createPrettyPrint()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createPrettyPrint</h4>
<pre>public static <a href="../../../org/dom4j/io/OutputFormat.html" title="class in org.dom4j.io">OutputFormat</a> createPrettyPrint()</pre>
<div class="block">A static helper method to create the default pretty printing format. This
format consists of an indent of 2 spaces, newlines after each element and
all other whitespace trimmed, and XMTML is false.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="createCompactFormat()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createCompactFormat</h4>
<pre>public static <a href="../../../org/dom4j/io/OutputFormat.html" title="class in org.dom4j.io">OutputFormat</a> createCompactFormat()</pre>
<div class="block">A static helper method to create the default compact format. This format
does not have any indentation or newlines after an alement and all other
whitespace trimmed</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>DOCUMENT ME!</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/OutputFormat.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/HTMLWriter.html" title="class in org.dom4j.io"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/dom4j/io/SAXContentHandler.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/OutputFormat.html" target="_top">Frames</a></li>
<li><a href="OutputFormat.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>
|