/usr/share/doc/libjdom2-java/api/org/jdom2/output/LineSeparator.html is in libjdom2-java-doc 2.0.6-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 | <!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_55) on Sat May 24 05:15:00 UTC 2014 -->
<title>LineSeparator (JDOM v2.x)</title>
<meta name="date" content="2014-05-24">
<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="LineSeparator (JDOM v2.x)";
}
//-->
</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/LineSeparator.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 class="aboutLanguage"><em><b>JDOM<br><font size='-1'>2.x</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jdom2/output/JDOMLocator.html" title="interface in org.jdom2.output"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/jdom2/output/SAXOutputter.html" title="class in org.jdom2.output"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom2/output/LineSeparator.html" target="_top">Frames</a></li>
<li><a href="LineSeparator.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="#enum_constant_summary">Enum Constants</a> | </li>
<li>Field | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#enum_constant_detail">Enum Constants</a> | </li>
<li>Field | </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.jdom2.output</div>
<h2 title="Enum LineSeparator" class="title">Enum LineSeparator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Enum<<a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a>></li>
<li>
<ul class="inheritance">
<li>org.jdom2.output.LineSeparator</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a>></dd>
</dl>
<hr>
<br>
<pre>public enum <span class="strong">LineSeparator</span>
extends java.lang.Enum<<a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a>></pre>
<div class="block">An enumeration of common separators that are used for JDOM output.
<p>
These enumerated values can be used as input to the
<a href="../../../org/jdom2/output/Format.html#setLineSeparator(org.jdom2.output.LineSeparator)"><code>Format.setLineSeparator(LineSeparator)</code></a> method. Additionally, the
names of these constants can be also be used in the System Property
<a href="../../../org/jdom2/JDOMConstants.html#JDOM2_PROPERTY_LINE_SEPARATOR"><code>JDOMConstants.JDOM2_PROPERTY_LINE_SEPARATOR</code></a> which is used to
define the default Line Separator sequence for JDOM output. See
<a href="../../../org/jdom2/output/LineSeparator.html#DEFAULT"><code>DEFAULT</code></a> Javadoc.
<p>
JDOM has historically used the CR/NL sequence '\r\n' as a line-terminator.
This sequence has the advantage that the output is easily opened in the
'Notepad' editor on Windows. Other editors on other platforms are typically
smart enough to automatically adjust to whatever termination sequence is
used in the document. The XML specification requires that the CR/NL sequence
should be 'normalized' to a single newline '\n' when the document is parsed
(<a href="http://www.w3.org/TR/xml11/#sec-line-ends">XML 1.1 End-Of-Line
Handling</a>). As a result there is no XML issue with the JDOM default CR/NL
end-of-line sequence.
<p>
It should be noted that because JDOM internally stores just a '\n' as a line
separator that any other output separator requires additional processing to
output. There is a distinct performance benefit for using the UNIX, or NL
LineSeparator for output.
<p>
JDOM has always allowed the line-terminating sequence to be customised (or
even disabled) for each <a href="../../../org/jdom2/output/XMLOutputter.html" title="class in org.jdom2.output"><code>XMLOutputter</code></a> operation by using this Format
class.
<p>
JDOM2 introduces two new features in relation to the end-of-line sequence.
Firstly, it introduces this new <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output"><code>LineSeparator</code></a> enumeration which
formalises the common line separators that can be used. In addition to the
simple String-based <a href="../../../org/jdom2/output/Format.html#setLineSeparator(java.lang.String)"><code>Format.setLineSeparator(String)</code></a> method you can
now also call <a href="../../../org/jdom2/output/Format.html#setLineSeparator(org.jdom2.output.LineSeparator)"><code>Format.setLineSeparator(LineSeparator)</code></a> with one of the
common enumerations.
<p>
The second new JDOM2 feature is the ability to set a global default
end-of-line sequence. JDOM 1.x forced the default sequence to be the CRLF
sequence, but JDOM2 allows you to set the system property
<a href="../../../org/jdom2/JDOMConstants.html#JDOM2_PROPERTY_LINE_SEPARATOR"><code>JDOMConstants.JDOM2_PROPERTY_LINE_SEPARATOR</code></a> which will be used as the
default sequence for Format. You can set the property to be the name of one
of these LineSeparator enumerations too. For example, the following will
cause all default Format instances to use the System-dependent end-of-line
sequence instead of always CRLF:
<p>
<pre>
java -Dorg.jdom2.output.LineSeparator=SYSTEM ...
</pre></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>JDOM2</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Rolf Lear</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum_constant_summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Enum Constant and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/jdom2/output/LineSeparator.html#CR">CR</a></strong></code>
<div class="block">The Separator sequence CR which is '\r'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/jdom2/output/LineSeparator.html#CRNL">CRNL</a></strong></code>
<div class="block">The Separator sequence CRNL which is '\r\n'.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/jdom2/output/LineSeparator.html#DEFAULT">DEFAULT</a></strong></code>
<div class="block">Use the sequence '\r\n' unless the System property
<a href="../../../org/jdom2/JDOMConstants.html#JDOM2_PROPERTY_LINE_SEPARATOR"><code>JDOMConstants.JDOM2_PROPERTY_LINE_SEPARATOR</code></a> is defined, in which
case use the value specified in that property.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/jdom2/output/LineSeparator.html#DOS">DOS</a></strong></code>
<div class="block">The 'DOS' Separator sequence CRLF (CRNL) which is '\r\n'.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/jdom2/output/LineSeparator.html#NL">NL</a></strong></code>
<div class="block">The Separator sequence NL which is '\n'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/jdom2/output/LineSeparator.html#NONE">NONE</a></strong></code>
<div class="block">Perform no end-of-line processing.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/jdom2/output/LineSeparator.html#SYSTEM">SYSTEM</a></strong></code>
<div class="block">The system-dependent Separator sequence NL which is obtained from
<code>System.getProperty("line.separator")</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/jdom2/output/LineSeparator.html#UNIX">UNIX</a></strong></code>
<div class="block">The 'UNIX' Separator sequence NL which is '\n'.</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>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/output/LineSeparator.html#value()">value</a></strong>()</code>
<div class="block">The String sequence used for this Separator</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/output/LineSeparator.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/output/LineSeparator.html#values()">values</a></strong>()</code>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
</ul>
<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>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum_constant_detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a name="CRNL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CRNL</h4>
<pre>public static final <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a> CRNL</pre>
<div class="block">The Separator sequence CRNL which is '\r\n'.
This is the default sequence.</div>
</li>
</ul>
<a name="NL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NL</h4>
<pre>public static final <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a> NL</pre>
<div class="block">The Separator sequence NL which is '\n'.</div>
</li>
</ul>
<a name="CR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CR</h4>
<pre>public static final <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a> CR</pre>
<div class="block">The Separator sequence CR which is '\r'.</div>
</li>
</ul>
<a name="DOS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DOS</h4>
<pre>public static final <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a> DOS</pre>
<div class="block">The 'DOS' Separator sequence CRLF (CRNL) which is '\r\n'.</div>
</li>
</ul>
<a name="UNIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNIX</h4>
<pre>public static final <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a> UNIX</pre>
<div class="block">The 'UNIX' Separator sequence NL which is '\n'.</div>
</li>
</ul>
<a name="SYSTEM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SYSTEM</h4>
<pre>public static final <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a> SYSTEM</pre>
<div class="block">The system-dependent Separator sequence NL which is obtained from
<code>System.getProperty("line.separator")</code>. This should be
the equivalent of <a href="../../../org/jdom2/output/LineSeparator.html#DOS"><code>DOS</code></a> on windows platforms, and
of <a href="../../../org/jdom2/output/LineSeparator.html#UNIX"><code>UNIX</code></a> on UNIX and Apple systems (after Mac OSX).</div>
</li>
</ul>
<a name="NONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NONE</h4>
<pre>public static final <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a> NONE</pre>
<div class="block">Perform no end-of-line processing.</div>
</li>
</ul>
<a name="DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT</h4>
<pre>public static final <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a> DEFAULT</pre>
<div class="block">Use the sequence '\r\n' unless the System property
<a href="../../../org/jdom2/JDOMConstants.html#JDOM2_PROPERTY_LINE_SEPARATOR"><code>JDOMConstants.JDOM2_PROPERTY_LINE_SEPARATOR</code></a> is defined, in which
case use the value specified in that property. If the value in that
property matches one of the Enumeration names (e.g. SYSTEM) then use the
sequence specified in that enumeration.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="values()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public static <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a>[] values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (LineSeparator c : LineSeparator.values())
System.out.println(c);
</pre></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in
the order they are declared</dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static <a href="../../../org/jdom2/output/LineSeparator.html" title="enum in org.jdom2.output">LineSeparator</a> valueOf(java.lang.String name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant
with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl>
</li>
</ul>
<a name="value()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>value</h4>
<pre>public java.lang.String value()</pre>
<div class="block">The String sequence used for this Separator</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an End-Of-Line String</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/LineSeparator.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 class="aboutLanguage"><em><b>JDOM<br><font size='-1'>2.x</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jdom2/output/JDOMLocator.html" title="interface in org.jdom2.output"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/jdom2/output/SAXOutputter.html" title="class in org.jdom2.output"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom2/output/LineSeparator.html" target="_top">Frames</a></li>
<li><a href="LineSeparator.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="#enum_constant_summary">Enum Constants</a> | </li>
<li>Field | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#enum_constant_detail">Enum Constants</a> | </li>
<li>Field | </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 ? 2014 Jason Hunter, Brett McLaughlin. All Rights Reserved.</small></p>
</body>
</html>
|