dom4j 2.1.4 · org.dom4j.io.OutputFormat

Modifier and Type	Field and Description
private char	attributeQuoteChar Quote character to use when writing attributes.
private boolean	doXHTML Whether or not to use XHTML standard.
private String	encoding The encoding format
private boolean	expandEmptyElements Whether or not to expand empty elements to <tagName></tagName> - default is `false`
private String	indent The default indent is no spaces (as original document)
private String	lineSeparator New line separator
private boolean	newLineAfterDeclaration Whether or not to print new line after the XML declaration - default is `true`
private int	newLineAfterNTags Controls when to output a line.separtor every so many tags in case of no lines and total text trimming.
private boolean	newlines The default new line flag, set to do new lines only as in original document
private boolean	omitEncoding Whether or not to output the encoding in the XML declaration - default is `false`
private boolean	padText pad string-element boundaries with whitespace
protected static final String	STANDARD_INDENT standard value to indent by, if we are indenting
private boolean	suppressDeclaration Whether or not to suppress the XML declaration - default is `false`
private boolean	trimText should we preserve whitespace or not in text nodes?

Access	Constructor and Description
public	OutputFormat() Creates an `OutputFormat` with no additional whitespace (indent or new lines) added.
public	OutputFormat(String is the indent string to be used for indentation (usually a number of spaces). indent) Creates an `OutputFormat` with the given indent added but no new lines added.
public	OutputFormat(String is the indent string to be used for indentation (usually a number of spaces). indent, boolean whether new lines are added to layout the newlines) Creates an `OutputFormat` with the given indent added with optional newlines between the Elements.
public	OutputFormat(String is the indent string to be used for indentation (usually a number of spaces). indent, boolean whether new lines are added to layout the newlines, String is the text encoding to use for writing the XML encoding) Creates an `OutputFormat` with the given indent added with optional newlines between the Elements and the given encoding format.

Method Summary

Modifier and Type	Method and Description
public static OutputFormat	Returns: DOCUMENT ME! createCompactFormat() A static helper method to create the default compact format.
public static OutputFormat	Returns: DOCUMENT ME! createPrettyPrint() A static helper method to create the default pretty printing format.
public char	getAttributeQuoteCharacter()
public String	getEncoding()
public String	getIndent()
public String	getLineSeparator()
public int	getNewLineAfterNTags()
public boolean	isExpandEmptyElements()
public boolean	Returns: true if a new line should be printed following XML declaration isNewLineAfterDeclaration() DOCUMENT ME!
public boolean	isNewlines()
public boolean	isOmitEncoding()
public boolean	isPadText()
public boolean	Returns: true if the output of the XML declaration (`<?xml version="1.0"?>`) should be suppressed else false. isSuppressDeclaration() DOCUMENT ME!
public boolean	isTrimText()
public boolean	Returns: DOCUMENT ME! isXHTML() Whether or not to use the XHTML standard: like HTML but passes an XML parser with real, closed tags.
public int	Returns: the index of first parameter that we didn't understand parseOptions(String[] is the array of command line arguments args, int is the index in args to start parsing options i) Parses command line arguments of the form `-omitEncoding -indentSize 3 -newlines -trimText`
public void	setAttributeQuoteCharacter(char The character to use when quoting attribute values. quoteChar) Sets the character used to quote attribute values.
public void	setEncoding(String encoding format encoding) DOCUMENT ME!
public void	setExpandEmptyElements(boolean `boolean` indicating whether or not empty elements should be expanded. expandEmptyElements) This will set whether empty elements are expanded from `<tagName>` to `<tagName></tagName>`.
public void	setIndent(String `String` to use for indentation. indent) This will set the indent `String` to use; this is usually a `String` of empty spaces.
public void	setIndent(boolean if true, set indenting on; if false, set indenting off doIndent) Set the indent on or off.
public void	setIndentSize(int `int` number of spaces in indentation. indentSize) This will set the indent `String`'s size; an indentSize of 4 would result in the indention being equivalent to the `String` " " (four space characters).
public void	setLineSeparator(String `String` line separator to use. separator) This will set the new-line separator.
public void	setNewLineAfterDeclaration(boolean `boolean` indicating whether or not to print new line following the XML declaration. The default is true. newLineAfterDeclaration) This will set whether a new line is printed after the XML declaration (assuming it is not supressed.)
public void	setNewLineAfterNTags(int DOCUMENT ME! tagCount) Controls output of a line.separator every tagCount tags when isNewlines is false.
public void	setNewlines(boolean `true` indicates new lines should be printed, else new lines are ignored (compacted). newlines) DOCUMENT ME!
public void	setOmitEncoding(boolean `boolean` indicating whether or not the XML declaration should indicate the document encoding. omitEncoding) This will set whether the XML declaration (`<?xml version="1.0" encoding="UTF-8"?`
public void	setPadText(boolean `boolean` if true, pad string-element boundaries padText) Ensure that text immediately preceded by or followed by an element will be "padded" with a single space.
public void	setSuppressDeclaration(boolean `boolean` indicating whether or not the XML declaration should be suppressed. suppressDeclaration) This will set whether the XML declaration (`<?xml version="1.0" encoding="UTF-8"?`
public void	setTrimText(boolean `boolean` true → trim the whitespace, false → use text verbatim trimText) This will set whether the text is output verbatim (false) or with whitespace stripped as per `org.dom4j.Element#getTextTrim()`.
public void	setXHTML(boolean `boolean` true → conform to XHTML, false → conform to HTML, can have unclosed tags, etc. xhtml) This will set whether or not to use the XHTML standard: like HTML but passes an XML parser with real, closed tags.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attributeQuoteChar	back to summary
private char attributeQuoteChar Quote character to use when writing attributes.

doXHTML	back to summary
private boolean doXHTML Whether or not to use XHTML standard.

encoding	back to summary
private String encoding The encoding format

expandEmptyElements	back to summary
private boolean expandEmptyElements Whether or not to expand empty elements to <tagName></tagName> - default is `false`

indent	back to summary
private String indent The default indent is no spaces (as original document)

lineSeparator	back to summary
private String lineSeparator New line separator

newLineAfterDeclaration	back to summary
private boolean newLineAfterDeclaration Whether or not to print new line after the XML declaration - default is `true`

newLineAfterNTags	back to summary
private int newLineAfterNTags Controls when to output a line.separtor every so many tags in case of no lines and total text trimming.

newlines	back to summary
private boolean newlines The default new line flag, set to do new lines only as in original document

omitEncoding	back to summary
private boolean omitEncoding Whether or not to output the encoding in the XML declaration - default is `false`

padText	back to summary
private boolean padText pad string-element boundaries with whitespace

STANDARD_INDENT	back to summary
protected static final String STANDARD_INDENT standard value to indent by, if we are indenting

suppressDeclaration	back to summary
private boolean suppressDeclaration Whether or not to suppress the XML declaration - default is `false`

trimText	back to summary
private boolean trimText should we preserve whitespace or not in text nodes?

Constructor Detail

OutputFormat	back to summary
public OutputFormat() Creates an `OutputFormat` with no additional whitespace (indent or new lines) added. The whitespace from the element text content is fully preserved.

OutputFormat back to summary

OutputFormat	back to summary
public OutputFormat(String indent) Creates an `OutputFormat` with the given indent added but no new lines added. All whitespace from element text will be included. Parameters indent:String is the indent string to be used for indentation (usually a number of spaces).

public OutputFormat(String indent)

Creates an OutputFormat with the given indent added but no new lines added. All whitespace from element text will be included.

Parameters

indent:String: is the indent string to be used for indentation (usually a number of spaces).

OutputFormat back to summary

OutputFormat	back to summary
public OutputFormat(String indent, boolean newlines) Creates an `OutputFormat` with the given indent added with optional newlines between the Elements. All whitespace from element text will be included. Parameters indent:String is the indent string to be used for indentation (usually a number of spaces). newlines:boolean whether new lines are added to layout the

public OutputFormat(String indent, boolean newlines)

Creates an OutputFormat with the given indent added with optional newlines between the Elements. All whitespace from element text will be included.

Parameters

indent:String: is the indent string to be used for indentation (usually a number of spaces).
newlines:boolean: whether new lines are added to layout the

OutputFormat back to summary

OutputFormat	back to summary
public OutputFormat(String indent, boolean newlines, String encoding) Creates an `OutputFormat` with the given indent added with optional newlines between the Elements and the given encoding format. Parameters indent:String is the indent string to be used for indentation (usually a number of spaces). newlines:boolean whether new lines are added to layout the encoding:String is the text encoding to use for writing the XML

public OutputFormat(String indent, boolean newlines, String encoding)

Creates an OutputFormat with the given indent added with optional newlines between the Elements and the given encoding format.

Parameters

indent:String: is the indent string to be used for indentation (usually a number of spaces).
newlines:boolean: whether new lines are added to layout the
encoding:String: is the text encoding to use for writing the XML

Method Detail

createCompactFormat	back to summary
public static OutputFormat createCompactFormat() 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 Returns:OutputFormat DOCUMENT ME!

createCompactFormat

back to summary

public static OutputFormat createCompactFormat()

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

Returns:OutputFormat: DOCUMENT ME!

createPrettyPrint	back to summary
public static OutputFormat createPrettyPrint() 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. Returns:OutputFormat DOCUMENT ME!

createPrettyPrint

back to summary

public static OutputFormat createPrettyPrint()

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.

Returns:OutputFormat: DOCUMENT ME!

getAttributeQuoteCharacter	back to summary
public char getAttributeQuoteCharacter()

getEncoding	back to summary
public String getEncoding()

getIndent	back to summary
public String getIndent()

getLineSeparator	back to summary
public String getLineSeparator()

getNewLineAfterNTags	back to summary
public int getNewLineAfterNTags()

isExpandEmptyElements	back to summary
public boolean isExpandEmptyElements()

isNewLineAfterDeclaration	back to summary
public boolean isNewLineAfterDeclaration() DOCUMENT ME! Returns:boolean true if a new line should be printed following XML declaration

isNewLineAfterDeclaration

back to summary

public boolean isNewLineAfterDeclaration()

DOCUMENT ME!

Returns:boolean: true if a new line should be printed following XML declaration

isNewlines	back to summary
public boolean isNewlines()

isOmitEncoding	back to summary
public boolean isOmitEncoding()

isPadText	back to summary
public boolean isPadText()

isSuppressDeclaration back to summary

isSuppressDeclaration	back to summary
public boolean isSuppressDeclaration() DOCUMENT ME! Returns:boolean true if the output of the XML declaration (`<?xml version="1.0"?>`) should be suppressed else false.

public boolean isSuppressDeclaration()

DOCUMENT ME!

Returns:boolean: true if the output of the XML declaration (<?xml version="1.0"?>) should be suppressed else false.

isTrimText	back to summary
public boolean isTrimText()

isXHTML back to summary

isXHTML	back to summary
public boolean isXHTML() 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: ( " <![CDATA[ " and " ]]> " ) otherwise, the class HTMLWriter will output the CDATA text, but not the delimiters. Default is `false` Returns:boolean DOCUMENT ME!

public boolean isXHTML()

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: ( " <![CDATA[ " and " ]]> " ) otherwise, the class HTMLWriter will output the CDATA text, but not the delimiters. Default is false

Returns:boolean: DOCUMENT ME!

parseOptions back to summary

parseOptions	back to summary
public int parseOptions(String[] args, int i) Parses command line arguments of the form `-omitEncoding -indentSize 3 -newlines -trimText` Parameters args:String[] is the array of command line arguments i:int is the index in args to start parsing options Returns:int the index of first parameter that we didn't understand

public int parseOptions(String[] args, int i)

Parses command line arguments of the form -omitEncoding -indentSize 3 -newlines -trimText

Parameters

args:String[]: is the array of command line arguments
i:int: is the index in args to start parsing options

Returns:int

the index of first parameter that we didn't understand

setAttributeQuoteCharacter back to summary

setAttributeQuoteCharacter	back to summary
public void setAttributeQuoteCharacter(char quoteChar) Sets the character used to quote attribute values. The specified character must be a valid XML attribute quote character, otherwise an `IllegalArgumentException` will be thrown. Parameters quoteChar:char The character to use when quoting attribute values. Exceptions IllegalArgumentException: If the specified character is not a valid XML attribute quote character.

public void setAttributeQuoteCharacter(char quoteChar)

Sets the character used to quote attribute values. The specified character must be a valid XML attribute quote character, otherwise an IllegalArgumentException will be thrown.

Parameters

quoteChar:char: The character to use when quoting attribute values.

Exceptions

IllegalArgumentException:: If the specified character is not a valid XML attribute quote character.

setEncoding	back to summary
public void setEncoding(String encoding) DOCUMENT ME! Parameters encoding:String encoding format

setEncoding

back to summary

public void setEncoding(String encoding)

DOCUMENT ME!

Parameters

encoding:String: encoding format

setExpandEmptyElements back to summary

setExpandEmptyElements	back to summary
public void setExpandEmptyElements(boolean expandEmptyElements) This will set whether empty elements are expanded from `<tagName>` to `<tagName></tagName>`. Parameters expandEmptyElements:boolean `boolean` indicating whether or not empty elements should be expanded.

public void setExpandEmptyElements(boolean expandEmptyElements)

This will set whether empty elements are expanded from <tagName> to <tagName></tagName>.

Parameters

expandEmptyElements:boolean: boolean indicating whether or not empty elements should be expanded.

setIndent back to summary

setIndent	back to summary
public void setIndent(String indent) This will set the indent `String` to use; this is usually a `String` of empty spaces. If you pass null, or the empty string (""), then no indentation will happen. Default: none (null) Parameters indent:String `String` to use for indentation.

public void setIndent(String indent)

This will set the indent String to use; this is usually a String of empty spaces. If you pass null, or the empty string (""), then no indentation will happen. Default: none (null)

Parameters

indent:String: String to use for indentation.

setIndent	back to summary
public void setIndent(boolean doIndent) Set the indent on or off. If setting on, will use the value of STANDARD_INDENT, which is usually two spaces. Parameters doIndent:boolean if true, set indenting on; if false, set indenting off

setIndent

back to summary

public void setIndent(boolean doIndent)

Set the indent on or off. If setting on, will use the value of STANDARD_INDENT, which is usually two spaces.

Parameters

doIndent:boolean: if true, set indenting on; if false, set indenting off

setIndentSize back to summary

setIndentSize	back to summary
public void setIndentSize(int indentSize) This will set the indent `String`'s size; an indentSize of 4 would result in the indention being equivalent to the `String` " " (four space characters). Parameters indentSize:int `int` number of spaces in indentation.

public void setIndentSize(int indentSize)

This will set the indent String's size; an indentSize of 4 would result in the indention being equivalent to the String " " (four space characters).

Parameters

indentSize:int: int number of spaces in indentation.

setLineSeparator back to summary

setLineSeparator	back to summary
public void setLineSeparator(String separator) This will set the new-line separator. The default is `\n`. Note that if the "newlines" property is false, this value is irrelevant. To make it output the system default line ending string, call `setLineSeparator(System.getProperty("line.separator"))` Parameters separator:String `String` line separator to use. See Also `setNewlines(boolean)`

public void setLineSeparator(String separator)

This will set the new-line separator. The default is \n. Note that if the "newlines" property is false, this value is irrelevant. To make it output the system default line ending string, call setLineSeparator(System.getProperty("line.separator"))

Parameters

separator:String: String line separator to use.

See Also

setNewlines(boolean)

setNewLineAfterDeclaration back to summary

setNewLineAfterDeclaration	back to summary
public void setNewLineAfterDeclaration(boolean newLineAfterDeclaration) This will set whether a new line is printed after the XML declaration (assuming it is not supressed.) Parameters newLineAfterDeclaration:boolean `boolean` indicating whether or not to print new line following the XML declaration. The default is true.

public void setNewLineAfterDeclaration(boolean newLineAfterDeclaration)

This will set whether a new line is printed after the XML declaration (assuming it is not supressed.)

Parameters

newLineAfterDeclaration:boolean: boolean indicating whether or not to print new line following the XML declaration. The default is true.

setNewLineAfterNTags	back to summary
public void setNewLineAfterNTags(int tagCount) 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). Parameters tagCount:int DOCUMENT ME!

setNewLineAfterNTags

back to summary

public void setNewLineAfterNTags(int tagCount)

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).

Parameters

tagCount:int: DOCUMENT ME!

setNewlines back to summary

setNewlines	back to summary
public void setNewlines(boolean newlines) DOCUMENT ME! Parameters newlines:boolean `true` indicates new lines should be printed, else new lines are ignored (compacted). See Also `setLineSeparator(String)`

public void setNewlines(boolean newlines)

DOCUMENT ME!

Parameters

newlines:boolean: true indicates new lines should be printed, else new lines are ignored (compacted).

See Also

setLineSeparator(String)

setOmitEncoding back to summary

setOmitEncoding	back to summary
public void setOmitEncoding(boolean omitEncoding) This will set whether the XML declaration (`<?xml version="1.0" encoding="UTF-8"?>`) includes the encoding of the document. It is common to suppress this in protocols such as WML and SOAP. Parameters omitEncoding:boolean `boolean` indicating whether or not the XML declaration should indicate the document encoding.

public void setOmitEncoding(boolean omitEncoding)

This will set whether the XML declaration (<?xml version="1.0" encoding="UTF-8"?>) includes the encoding of the document. It is common to suppress this in protocols such as WML and SOAP.

Parameters

omitEncoding:boolean: boolean indicating whether or not the XML declaration should indicate the document encoding.

setPadText back to summary

setPadText	back to summary
public void setPadText(boolean padText) 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., `The quick <b>brown</b> fox` into `The quick<b>brown</b>fox` (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 `setTrimText`. The padding string will only be added if the text itself starts or ends with some whitespace characters. Default: false Parameters padText:boolean `boolean` if true, pad string-element boundaries

public void setPadText(boolean padText)

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., The quick <b>brown</b> fox into The quick<b>brown</b>fox (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 setTrimText. The padding string will only be added if the text itself starts or ends with some whitespace characters. Default: false

Parameters

padText:boolean: boolean if true, pad string-element boundaries

setSuppressDeclaration back to summary

setSuppressDeclaration	back to summary
public void setSuppressDeclaration(boolean suppressDeclaration) This will set whether the XML declaration (`<?xml version="1.0" encoding="UTF-8"?>`) is included or not. It is common to suppress this in protocols such as WML and SOAP. Parameters suppressDeclaration:boolean `boolean` indicating whether or not the XML declaration should be suppressed.

public void setSuppressDeclaration(boolean suppressDeclaration)

This will set whether the XML declaration (<?xml version="1.0" encoding="UTF-8"?>) is included or not. It is common to suppress this in protocols such as WML and SOAP.

Parameters

suppressDeclaration:boolean: boolean indicating whether or not the XML declaration should be suppressed.

setTrimText back to summary

public void setTrimText(boolean trimText)

This will set whether the text is output verbatim (false) or with whitespace stripped as per org.dom4j.Element#getTextTrim(). Default: false

Parameters

trimText:boolean: boolean true → trim the whitespace, false → use text verbatim

setXHTML back to summary

public void setXHTML(boolean xhtml)

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: ( " <[CDATA[ " and " ]]< ) otherwise, the class HTMLWriter will output the CDATA text, but not the delimiters. Default: false

Parameters

xhtml:boolean: boolean true → conform to XHTML, false → conform to HTML, can have unclosed tags, etc.

public Class OutputFormat

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail