public enum LineSeparator extends java.lang.Enum<LineSeparator>
These enumerated values can be used as input to the
Format.setLineSeparator(LineSeparator) method. Additionally, the
names of these constants can be also be used in the System Property
JDOMConstants.JDOM2_PROPERTY_LINE_SEPARATOR which is used to
define the default Line Separator sequence for JDOM output. See
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 (XML 1.1 End-Of-Line Handling). As a result there is no XML issue with the JDOM default CR/NL end-of-line sequence.
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.
JDOM has always allowed the line-terminating sequence to be customised (or
even disabled) for each
XMLOutputter operation by using this Format
JDOM2 introduces two new features in relation to the end-of-line sequence.
Firstly, it introduces this new
LineSeparator enumeration which
formalises the common line separators that can be used. In addition to the
Format.setLineSeparator(String) method you can
now also call
Format.setLineSeparator(LineSeparator) with one of the
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
JDOMConstants.JDOM2_PROPERTY_LINE_SEPARATOR 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:
java -Dorg.jdom2.output.LineSeparator=SYSTEM ...
|Enum Constant and Description|
The Separator sequence CR which is '\r'.
The Separator sequence CRNL which is '\r\n'.
Use the sequence '\r\n' unless the System property
The 'DOS' Separator sequence CRLF (CRNL) which is '\r\n'.
The Separator sequence NL which is '\n'.
Perform no end-of-line processing.
The system-dependent Separator sequence NL which is obtained from
The 'UNIX' Separator sequence NL which is '\n'.
|Modifier and Type||Method and Description|
The String sequence used for this Separator
Returns the enum constant of this type with the specified name.
Returns an array containing the constants of this enum type, in the order they are declared.
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
public static final LineSeparator CRNL
public static final LineSeparator NL
public static final LineSeparator CR
public static final LineSeparator DOS
public static final LineSeparator UNIX
public static final LineSeparator SYSTEM
public static final LineSeparator NONE
public static final LineSeparator DEFAULT
JDOMConstants.JDOM2_PROPERTY_LINE_SEPARATORis 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.
public static LineSeparator values()
for (LineSeparator c : LineSeparator.values()) System.out.println(c);
public static LineSeparator valueOf(java.lang.String name)
name- the name of the enum constant to be returned.
java.lang.IllegalArgumentException- if this enum type has no constant with the specified name
java.lang.NullPointerException- if the argument is null
public java.lang.String value()
Copyright © 2021 Jason Hunter, Brett McLaughlin. All Rights Reserved.