|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.dom4j.io.OutputFormat
OutputFormat
represents the format configuration used by
and its base classes to format the XML output
Field Summary | |
protected static String |
STANDARD_INDENT
standard value to indent by, if we are indenting |
Constructor Summary | |
OutputFormat()
Creates an OutputFormat with no additional whitespace
(indent or new lines) added. |
|
OutputFormat(String indent)
Creates an OutputFormat with the given indent added but no
new lines added. |
|
OutputFormat(String indent,
boolean newlines)
Creates an OutputFormat with the given indent added with
optional newlines between the Elements. |
|
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. |
Method Summary | |
static OutputFormat |
createCompactFormat()
A static helper method to create the default compact format. |
static OutputFormat |
createPrettyPrint()
A static helper method to create the default pretty printing format. |
char |
getAttributeQuoteCharacter()
|
String |
getEncoding()
|
String |
getIndent()
|
String |
getLineSeparator()
|
int |
getNewLineAfterNTags()
|
boolean |
isExpandEmptyElements()
|
boolean |
isNewLineAfterDeclaration()
DOCUMENT ME! |
boolean |
isNewlines()
|
boolean |
isOmitEncoding()
|
boolean |
isPadText()
|
boolean |
isSuppressDeclaration()
DOCUMENT ME! |
boolean |
isTrimText()
|
boolean |
isXHTML()
Whether or not to use the XHTML standard: like HTML but passes an XML parser with real, closed tags. |
int |
parseOptions(String[] args,
int i)
Parses command line arguments of the form -omitEncoding
-indentSize 3 -newlines -trimText |
void |
setAttributeQuoteCharacter(char quoteChar)
Sets the character used to quote attribute values. |
void |
setEncoding(String encoding)
DOCUMENT ME! |
void |
setExpandEmptyElements(boolean expandEmptyElements)
This will set whether empty elements are expanded from <tagName> to
<tagName></tagName> .
|
void |
setIndent(boolean doIndent)
Set the indent on or off. |
void |
setIndent(String indent)
This will set the indent String to use; this is usually a
String of empty spaces. |
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).
|
void |
setLineSeparator(String separator)
This will set the new-line separator. |
void |
setNewLineAfterDeclaration(boolean newLineAfterDeclaration)
This will set whether a new line is printed after the XML declaration (assuming it is not supressed.) |
void |
setNewLineAfterNTags(int tagCount)
Controls output of a line.separator every tagCount tags when isNewlines is false. |
void |
setNewlines(boolean newlines)
DOCUMENT ME! |
void |
setOmitEncoding(boolean omitEncoding)
This will set whether the XML declaration ( <? |
void |
setPadText(boolean padText)
Ensure that text immediately preceded by or followed by an element will be "padded" with a single space. |
void |
setSuppressDeclaration(boolean suppressDeclaration)
This will set whether the XML declaration ( <? |
void |
setTrimText(boolean trimText)
This will set whether the text is output verbatim (false) or with whitespace stripped as per .
|
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final String STANDARD_INDENT
Constructor Detail |
public OutputFormat()
OutputFormat
with no additional whitespace
(indent or new lines) added. The whitespace from the element text content
is fully preserved.
public OutputFormat(String indent)
OutputFormat
with the given indent added but no
new lines added. All whitespace from element text will be included.
indent
- is the indent string to be used for indentation (usually a
number of spaces).public OutputFormat(String indent, boolean newlines)
OutputFormat
with the given indent added with
optional newlines between the Elements. All whitespace from element text
will be included.
indent
- is the indent string to be used for indentation (usually a
number of spaces).newlines
- whether new lines are added to layout thepublic OutputFormat(String indent, boolean newlines, String encoding)
OutputFormat
with the given indent added with
optional newlines between the Elements and the given encoding format.
indent
- is the indent string to be used for indentation (usually a
number of spaces).newlines
- whether new lines are added to layout theencoding
- is the text encoding to use for writing the XMLMethod Detail |
public String getLineSeparator()
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"))
separator
- String
line separator to use.setNewlines(boolean)
public boolean isNewlines()
public void setNewlines(boolean newlines)
newlines
- true
indicates new lines should be printed,
else new lines are ignored (compacted).setLineSeparator(String)
public String getEncoding()
public void setEncoding(String encoding)
encoding
- encoding formatpublic boolean isOmitEncoding()
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.
omitEncoding
- boolean
indicating whether or not the XML
declaration should indicate the document encoding.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.
suppressDeclaration
- boolean
indicating whether or not the XML
declaration should be suppressed.public boolean isSuppressDeclaration()
<?xml
version="1.0"?>
)
should be suppressed else false.public void setNewLineAfterDeclaration(boolean newLineAfterDeclaration)
This will set whether a new line is printed after the XML declaration (assuming it is not supressed.)
newLineAfterDeclaration
- boolean
indicating whether or not to print new
line following the XML declaration. The default is true.public boolean isNewLineAfterDeclaration()
public boolean isExpandEmptyElements()
public void setExpandEmptyElements(boolean expandEmptyElements)
This will set whether empty elements are expanded from
<tagName>
to
<tagName></tagName>
.
expandEmptyElements
- boolean
indicating whether or not empty
elements should be expanded.public boolean isTrimText()
public void setTrimText(boolean trimText)
This will set whether the text is output verbatim (false) or with
whitespace stripped as per
.
Element.getTextTrim()
Default: false
trimText
- boolean
true=>trim the whitespace, false=>use
text verbatimpublic boolean isPadText()
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(boolean)
.
The padding string will only be added if the text itself starts or ends with some whitespace characters.
Default: false
padText
- boolean
if true, pad string-element boundariespublic String getIndent()
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.
indent
- String
to use for indentation.public void setIndent(boolean doIndent)
doIndent
- if true, set indenting on; if false, set indenting offpublic 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).
indentSize
- int
number of spaces in indentation.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
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
xhtml
- boolean
true=>conform to XHTML, false=>conform
to HTML, can have unclosed tags, etc.public int getNewLineAfterNTags()
public void setNewLineAfterNTags(int tagCount)
tagCount
- DOCUMENT ME!public char getAttributeQuoteCharacter()
public void setAttributeQuoteCharacter(char quoteChar)
IllegalArgumentException
will be thrown.
quoteChar
- The character to use when quoting attribute values.
IllegalArgumentException
- If the specified character is not a valid XML attribute quote
character.public int parseOptions(String[] args, int i)
-omitEncoding
-indentSize 3 -newlines -trimText
args
- is the array of command line argumentsi
- is the index in args to start parsing options
public static OutputFormat createPrettyPrint()
public static OutputFormat createCompactFormat()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |