Main Page   Packages   Namespace List   Class Hierarchy   Compound List   Compound Members  

XMLOutputter Class Reference

List of all members.

Public Methods

 XMLOutputter ()
 XMLOutputter (String indent)
 XMLOutputter (String indent, boolean newlines)
 XMLOutputter (String indent, boolean newlines, String encoding)
 XMLOutputter (XMLOutputter that)
void setLineSeparator (String separator)
void setNewlines (boolean newlines)
void setEncoding (String encoding)
void setOmitEncoding (boolean omitEncoding)
void setOmitDeclaration (boolean omitDeclaration)
void setExpandEmptyElements (boolean expandEmptyElements)
void setTrimAllWhite (boolean trimAllWhite)
void setTextTrim (boolean textTrim)
void setTextNormalize (boolean textNormalize)
void setIndent (String indent)
void setIndent (boolean doIndent)
void setIndent (int size)
void setIndentSize (int indentSize)
void output (Document doc, OutputStream out) throws IOException
void output (DocType doctype, OutputStream out) throws IOException
void output (Element element, OutputStream out) throws IOException
void outputElementContent (Element element, OutputStream out) throws IOException
void output (List list, OutputStream out) throws IOException
void output (CDATA cdata, OutputStream out) throws IOException
void output (Text text, OutputStream out) throws IOException
void output (String string, OutputStream out) throws IOException
void output (Comment comment, OutputStream out) throws IOException
void output (ProcessingInstruction pi, OutputStream out) throws IOException
void output (EntityRef entity, OutputStream out) throws IOException
void output (Document doc, Writer out) throws IOException
void output (DocType doctype, Writer out) throws IOException
void output (Element element, Writer out) throws IOException
void outputElementContent (Element element, Writer out) throws IOException
void output (List list, Writer out) throws IOException
void output (CDATA cdata, Writer out) throws IOException
void output (Text text, Writer out) throws IOException
void output (String string, Writer out) throws IOException
void output (Comment comment, Writer out) throws IOException
void output (ProcessingInstruction pi, Writer out) throws IOException
void output (EntityRef entity, Writer out) throws IOException
String outputString (Document doc)
String outputString (DocType doctype)
String outputString (Element element)
String outputString (List list)
String outputString (CDATA cdata)
String outputString (Text text)
String outputString (String str)
String outputString (Comment comment)
String outputString (ProcessingInstruction pi)
String outputString (EntityRef entity)
String escapeAttributeEntities (String str)
String escapeElementEntities (String str)
int parseArgs (String[] args, int i)
Object clone ()
String toString ()
void setPadText (boolean padText)
void setIndentLevel (int level)
void setSuppressDeclaration (boolean suppressDeclaration)

Protected Methods

Writer makeWriter (OutputStream out) throws java.io.UnsupportedEncodingException
Writer makeWriter (OutputStream out, String enc) throws java.io.UnsupportedEncodingException
void printDeclaration (Document doc, Writer out, String encoding) throws IOException
void printDocType (DocType docType, Writer out) throws IOException
void printComment (Comment comment, Writer out) throws IOException
void printProcessingInstruction (ProcessingInstruction pi, Writer out) throws IOException
void printEntityRef (EntityRef entity, Writer out) throws IOException
void printCDATA (CDATA cdata, Writer out) throws IOException
void printText (Text text, Writer out) throws IOException
void printString (String str, Writer out) throws IOException
void printElement (Element element, Writer out, int level, NamespaceStack namespaces) throws IOException
void printElementContent (Element element, Writer out, int level, NamespaceStack namespaces) throws IOException
void printContent (List content, Writer out, int level, NamespaceStack namespaces) throws IOException
void printContentRange (List content, int start, int end, Writer out, int level, NamespaceStack namespaces) throws IOException
void printTextRange (List content, int start, int end, Writer out) throws IOException
void printAttributes (List attributes, Element parent, Writer out, NamespaceStack namespaces) throws IOException
void newline (Writer out) throws IOException
void indent (Writer out) throws IOException
void indent (Writer out, int level) throws IOException
NamespaceStack createNamespaceStack ()

Detailed Description

XMLOutputter takes a JDOM tree and formats it to a stream as XML. The outputter can manage many styles of document formatting, from untouched to pretty printed. The default is to output the document content exactly as created, but this can be changed with the various set*() methods.

There are output(...) methods to print any of the standard JDOM classes, including Document and Element, to either a Writer or an OutputStream. Warning: When outputting to a Writer, make sure the writer's encoding matches the encoding setting in the XMLOutputter. This ensures the encoding in which the content is written (controlled by the Writer configuration) matches the encoding placed in the document's XML declaration (controlled by the XMLOutputter). Because a Writer cannot be queried for its encoding, the information must be passed to the XMLOutputter manually in its constructor or via the setEncoding() method. The default XMLOutputter encoding is UTF-8.

The methods outputString(...) are for convenience only; for top performance you should call one of the output(...) and pass in your own Writer or OutputStream if possible.

XML declarations are always printed on their own line followed by a line seperator (this doesn't change the semantics of the document). To omit printing of the declaration use setOmitDeclaration. To omit printing of the encoding in the declaration use setOmitEncoding. Unfortunatly there is currently no way to know the original encoding of the document.

Empty elements are by default printed as <empty/&gt, but this can be configured with setExpandEmptyElements to cause them to be expanded to <empty&gt</empty>.

Several modes are available to effect the way textual content is printed. All modes are configurable through corresponding set*() methods. Below is a table which explains the modes and the effect on the resulting output.

<th align="left"> Text Mode </th> <th> Resulting behavior. </th>

Default All content is printed in the format it was created, no whitespace or line separators are are added or removed.

TrimAllWhite Content between tags consisting of all whitespace is not printed. If the content contains even one non-whitespace character, it is printed verbatim, whitespace and all.

TextTrim Same as TrimAllWhite, plus leading/trailing whitespace are trimmed.

TextNormalize Same as TextTrim, in addition interior whitespace is compressed to a single space.

For pretty-print output, use setNewlines in conjunction with setIndent. Setting newlines to true causes tags to be aligned and possibly indented. With newlines true, whitespace might be added back to fit alignment needs. In most cases texual content is aligned with the surrounding tags (after the appropriate text mode is applied). In the case where the only content between the start and end tags is textual, the start tag, text, and end tag are all printed on the same line.

When a element has a xml:space attribute with the value of "preserve", all formating is turned off and reverts back to the default until the element and it's contents have been printed. If a nested element contains another xml:space with the value "default" formatting is turned back on for the child element and then off for the remainder of the parent element.

Author:
Brett McLaughlin , Jason Hunter , Jason Reid , Wolfgang Werner , Elliotte Rusty Harold , David & Will (from Post Tool Design) , Dan Schaffer , Alex Chaffee (alex@jguru.com) , Bradley S. Huffman
Version:
Revision:
1.74
,
Date:
2002/02/07 13:45:39


Constructor & Destructor Documentation

XMLOutputter::XMLOutputter   [inline]
 

This will create an XMLOutputter with no additional whitespace (indent or newlines) added; the whitespace from the element text content is fully preserved.

XMLOutputter::XMLOutputter String    indent [inline]
 

This will create an XMLOutputter with the given indent added but no new lines added; all whitespace from the element text content is included as well.

Parameters:
indent  the indent string, usually some number of spaces

XMLOutputter::XMLOutputter String    indent,
boolean    newlines
[inline]
 

This will create an XMLOutputter with the given indent that prints newlines only if newlines is true; all whitespace from the element text content is included as well.

Parameters:
indent  the indent String, usually some number of spaces
newlines  true indicates new lines should be printed, else new lines are ignored (compacted).

XMLOutputter::XMLOutputter String    indent,
boolean    newlines,
String    encoding
[inline]
 

This will create an XMLOutputter with the given indent and new lines printing only if newlines is true, and encoding format encoding.

Parameters:
indent  the indent String, usually some number of spaces
newlines  true indicates new lines should be printed, else new lines are ignored (compacted).
encoding  set encoding format. Use XML-style names like "UTF-8" or "ISO-8859-1" or "US-ASCII"

XMLOutputter::XMLOutputter XMLOutputter    that [inline]
 

This will create an XMLOutputter with all the options as set in the given XMLOutputter. Note that XMLOutputter two = (XMLOutputter)one.clone(); would work equally well.

Parameters:
that  the XMLOutputter to clone


Member Function Documentation

Object XMLOutputter::clone   [inline]
 

Returns a copy of this XMLOutputter.

NamespaceStack XMLOutputter::createNamespaceStack   [inline, protected]
 

Factory for making new NamespaceStack objects. The NamespaceStack created is actually an inner class extending the package protected NamespaceStack, as a way to make NamespaceStack "friendly" toward subclassers.

String XMLOutputter::escapeAttributeEntities String    str [inline]
 

This will take the pre-defined entities in XML 1.0 and convert their character representation to the appropriate entity reference, suitable for XML attributes. It does no converstion for ' because it's not necessary as the outputter writes attributes surrounded by double-quotes.

Parameters:
str  String input to escape.
Returns:
String with escaped content.

String XMLOutputter::escapeElementEntities String    str [inline]
 

This will take the three pre-defined entities in XML 1.0 (used specifically in XML elements) and convert their character representation to the appropriate entity reference, suitable for XML element content.

Parameters:
st  String input to escape.
Returns:
String with escaped content.

void XMLOutputter::indent Writer    out,
int    level
[inline, protected]
 

This will print indents (only if the newlines flag was set to true, and indent is non-null).

Parameters:
out  Writer to use
level  current indent level (number of tabs)

void XMLOutputter::indent Writer    out [inline, protected]
 

This will print indents (only if the newlines flag was set to true, and indent is non-null).

Parameters:
out  Writer to use
level  current indent level (number of tabs)
Deprecated:
since it's never used in XMLOutputter, used in XMLOutputter indent( out, 0) instead

Writer XMLOutputter::makeWriter OutputStream    out,
String    enc
[inline, protected]
 

Get an OutputStreamWriter, use specified encoding.

Writer XMLOutputter::makeWriter OutputStream    out [inline, protected]
 

Get an OutputStreamWriter, using prefered encoding (see setEncoding).

void XMLOutputter::newline Writer    out [inline, protected]
 

This will print a new line only if the newlines flag was set to true.

Parameters:
out  Writer to use

void XMLOutputter::output EntityRef    entity,
Writer    out
[inline]
 

Print out a EntityRef.

Parameters:
entity  EntityRef to output.
out  Writer to use.

void XMLOutputter::output ProcessingInstruction    pi,
Writer    out
[inline]
 

Print out a ProcessingInstruction.

Parameters:
element  ProcessingInstruction to output.
out  Writer to use.

void XMLOutputter::output Comment    comment,
Writer    out
[inline]
 

Print out a Comment.

Parameters:
comment  Comment to output.
out  Writer to use.

void XMLOutputter::output String    string,
Writer    out
[inline]
 

Print out a String. Perfoms the necessary entity escaping and whitespace stripping.

Parameters:
string  String to output.
out  Writer to use.
Deprecated:
see output(Text,Writer)

void XMLOutputter::output Text    text,
Writer    out
[inline]
 

Print out a Text node. Perfoms the necessary entity escaping and whitespace stripping.

Parameters:
text  Text to output.
out  Writer to use.

void XMLOutputter::output CDATA    cdata,
Writer    out
[inline]
 

Print out a CDATA node.

Parameters:
cdata  CDATA to output.
out  Writer to use.

void XMLOutputter::output List    list,
Writer    out
[inline]
 

This will handle printing out a list of nodes. This can be useful for printing the content of an element that contains HTML, like "<description>JDOM is <b>fun>!</description>".

Parameters:
list  List of nodes.
out  Writer to use.

void XMLOutputter::output Element    element,
Writer    out
[inline]
 

Print out an Element, including it's Attributes, and all contained (child) elements, etc.

Parameters:
element  Element to output.
out  Writer to use.

void XMLOutputter::output DocType    doctype,
Writer    out
[inline]
 

Print out the DocType.

Parameters:
doctype  DocType to output.
out  Writer to use.

void XMLOutputter::output Document    doc,
Writer    out
[inline]
 

This will print the Document to the given Writer.

Warning: using your own Writer may cause the outputter's preferred character encoding to be ignored. If you use encodings other than UTF-8, we recommend using the method that takes an OutputStream instead.

Parameters:
doc  Document to format.
out  Writer to use.
Exceptions:
IOException  - if there's any problem writing.

void XMLOutputter::output EntityRef    entity,
OutputStream    out
[inline]
 

Print out a EntityRef.

Parameters:
entity  EntityRef to output.
out  OutputStream to use.

void XMLOutputter::output ProcessingInstruction    pi,
OutputStream    out
[inline]
 

Print out a ProcessingInstruction.

Parameters:
processingInstruction  ProcessingInstruction to output.
out  OutputStream to use.

void XMLOutputter::output Comment    comment,
OutputStream    out
[inline]
 

Print out a Comment.

Parameters:
comment  Comment to output.
out  OutputStream to use.

void XMLOutputter::output String    string,
OutputStream    out
[inline]
 

Print out a String. Perfoms the necessary entity escaping and whitespace stripping.

Parameters:
string  String to output.
out  OutputStream to use.
Deprecated:
see output(Text,OutputStream)

void XMLOutputter::output Text    text,
OutputStream    out
[inline]
 

Print out a Text node. Perfoms the necessary entity escaping and whitespace stripping.

Parameters:
text  Text to output.
out  OutputStream to use.

void XMLOutputter::output CDATA    cdata,
OutputStream    out
[inline]
 

Print out a CDATA node.

Parameters:
cdata  CDATA to output.
out  OutputStream to use.

void XMLOutputter::output List    list,
OutputStream    out
[inline]
 

This will handle printing out a list of nodes. This can be useful for printing the content of an element that contains HTML, like "<description>JDOM is <b>fun>!</description>".

Parameters:
list  List of nodes.
out  OutputStream to use.

void XMLOutputter::output Element    element,
OutputStream    out
[inline]
 

Print out an Element, including it's Attributes, and all contained (child) elements, etc.

Parameters:
element  Element to output.
out  Writer to use.

void XMLOutputter::output DocType    doctype,
OutputStream    out
[inline]
 

Print out the DocType.

Parameters:
doctype  DocType to output.
out  OutputStream to use.

void XMLOutputter::output Document    doc,
OutputStream    out
[inline]
 

This will print the Document to the given output stream. The characters are printed using the encoding specified in the constructor, or a default of UTF-8.

Parameters:
doc  Document to format.
out  OutputStream to use.
Exceptions:
IOException  - if there's any problem writing.

void XMLOutputter::outputElementContent Element    element,
Writer    out
[inline]
 

This will handle printing out an Element's content only, not including its tag, and attributes. This can be useful for printing the content of an element that contains HTML, like "<description>JDOM is <b>fun>!</description>".

Parameters:
element  Element to output.
out  Writer to use.

void XMLOutputter::outputElementContent Element    element,
OutputStream    out
[inline]
 

This will handle printing out an Element's content only, not including its tag, and attributes. This can be useful for printing the content of an element that contains HTML, like "<description>JDOM is <b>fun>!</description>".

Parameters:
element  Element to output.
out  OutputStream to use.

String XMLOutputter::outputString EntityRef    entity [inline]
 

Return a string representing an entity. Warning: a String is Unicode, which may not match the outputter's specified encoding.

Parameters:
entity  EntityRef to format.

String XMLOutputter::outputString ProcessingInstruction    pi [inline]
 

Return a string representing a PI. Warning: a String is Unicode, which may not match the outputter's specified encoding.

Parameters:
pi  ProcessingInstruction to format.

String XMLOutputter::outputString Comment    comment [inline]
 

Return a string representing a comment. Warning: a String is Unicode, which may not match the outputter's specified encoding.

Parameters:
comment  Comment to format.

String XMLOutputter::outputString String    str [inline]
 

Return a string representing (with trimming, normalizatio, and escaping possibly applied) a String. Warning: a String is Unicode, which may not match the outputter's specified encoding.

Parameters:
str  String to format.

String XMLOutputter::outputString Text    text [inline]
 

Return a string representing a Text node. Warning: a String is Unicode, which may not match the outputter's specified encoding.

Parameters:
text  Text to format.

String XMLOutputter::outputString CDATA    cdata [inline]
 

Return a string representing a CDATA node. Warning: a String is Unicode, which may not match the outputter's specified encoding.

Parameters:
cdata  CDATA to format.

String XMLOutputter::outputString List    list [inline]
 

Return a string representing a list of nodes. The list is assumed to contain valid JDOM nodes.

Parameters:
list  List to format.

String XMLOutputter::outputString Element    element [inline]
 

Return a string representing an element. Warning: a String is Unicode, which may not match the outputter's specified encoding.

Parameters:
element  Element to format.

String XMLOutputter::outputString DocType    doctype [inline]
 

Return a string representing a DocType. Warning: a String is Unicode, which may not match the outputter's specified encoding.

Parameters:
doctype  DocType to format.

String XMLOutputter::outputString Document    doc [inline]
 

Return a string representing a document. Uses an internal StringWriter. Warning: a String is Unicode, which may not match the outputter's specified encoding.

Parameters:
doc  Document to format.

int XMLOutputter::parseArgs String    args[],
int    i
[inline]
 

Parse command-line arguments of the form -omitEncoding -indentSize 3 ...

Returns:
int index of first parameter that we didn't understand

void XMLOutputter::printAttributes List    attributes,
Element    parent,
Writer    out,
NamespaceStack    namespaces
[inline, protected]
 

This will handle printing of a Attribute list.

Parameters:
attributes  List of Attribute objcts
out  Writer to use

void XMLOutputter::printCDATA CDATA    cdata,
Writer    out
[inline, protected]
 

This will handle printing of CDATA text.

Parameters:
cdata  CDATA to output.
out  Writer to use.

void XMLOutputter::printComment Comment    comment,
Writer    out
[inline, protected]
 

This will handle printing of comments.

Parameters:
comment  Comment to write.
out  Writer to use.

void XMLOutputter::printContent List    content,
Writer    out,
int    level,
NamespaceStack    namespaces
[inline, protected]
 

This will handle printing of a Element's content only, not including it's tag, attributes, or namespace info.

Parameters:
content  List of content to output.
out  Writer to use.
level  int level of indentation.
namespaces  List stack of Namespaces in scope.

void XMLOutputter::printContentRange List    content,
int    start,
int    end,
Writer    out,
int    level,
NamespaceStack    namespaces
[inline, protected]
 

This will handle printing of content within a given range. The range to print is specified in typical Java fashion; the starting index is inclusive, while the ending index is exclusive.

Parameters:
content  List of content to output
starting  index of first content node (inclusive.
ending  index of last content node (exclusive).
out  Writer to use.
level  int level of indentation.
namespaces  List stack of Namespaces in scope.

void XMLOutputter::printDeclaration Document    doc,
Writer    out,
String    encoding
[inline, protected]
 

This will handle printing of the declaration. Assumes XML version 1.0 since we don't directly know.

Parameters:
doc  Document whose declaration to write.
out  Writer to use.
encoding  The encoding to add to the declaration

void XMLOutputter::printDocType DocType    docType,
Writer    out
[inline, protected]
 

This handle printing the DOCTYPE declaration if one exists.

Parameters:
doc  Document whose declaration to write.
out  Writer to use.

void XMLOutputter::printElement Element    element,
Writer    out,
int    level,
NamespaceStack    namespaces
[inline, protected]
 

This will handle printing of a Element, it's Attributes, and all contained (child) elements, etc.

Parameters:
element  Element to output.
out  Writer to use.
indent  int level of indention.
namespaces  List stack of Namespaces in scope.

void XMLOutputter::printElementContent Element    element,
Writer    out,
int    level,
NamespaceStack    namespaces
[inline, protected]
 

This will handle printing of a Element's content only, not including it's tag, attributes, or namespace info.

Parameters:
element  Element to output.
out  Writer to use.
level  int level of indentation.
namespaces  List stack of Namespaces in scope.

void XMLOutputter::printEntityRef EntityRef    entity,
Writer    out
[inline, protected]
 

This will handle printing a EntityRef. Only the entity reference such as &entity; will be printed. However, subclasses are free to override this method to print the contents of the entity instead.

Parameters:
entity  EntityRef to output.
out  Writer to use.

void XMLOutputter::printProcessingInstruction ProcessingInstruction    pi,
Writer    out
[inline, protected]
 

This will handle printing of processing instructions.

Parameters:
comment  ProcessingInstruction to write.
out  Writer to use.

void XMLOutputter::printString String    str,
Writer    out
[inline, protected]
 

This will handle printing a string. Escapes the element entities, trims interior whitespace, etc. if necessary.

void XMLOutputter::printText Text    text,
Writer    out
[inline, protected]
 

This will handle printing of Text strings.

Parameters:
text  Text to write.
out  Writer to use.

void XMLOutputter::printTextRange List    content,
int    start,
int    end,
Writer    out
[inline, protected]
 

This will handle printing of a sequence of CDATA or Text nodes. It is a error to have any other pass this method any other type of node.

Parameters:
content  List of content to output
starting  index of first content node (inclusive).
ending  index of last content node (exclusive).
out  Writer to use.

void XMLOutputter::setEncoding String    encoding [inline]
 

Sets the output encoding. The name should be an accepted XML encoding.

Parameters:
encoding  the encoding format. Use XML-style names like "UTF-8" or "ISO-8859-1" or "US-ASCII"

void XMLOutputter::setExpandEmptyElements boolean    expandEmptyElements [inline]
 

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

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

void XMLOutputter::setIndent int    size [inline]
 

This will set the indent String's size; a size of 4 would result in the indentation being equivalent to the String "    " (four spaces).

Parameters:
size  int number of spaces in indentation.

void XMLOutputter::setIndent boolean    doIndent [inline]
 

Set the indent on or off, newlines must be set to true for indentation to actually occur. If setting on, will use the value of STANDARD_INDENT, which is usually two spaces.

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

void XMLOutputter::setIndent String    indent [inline]
 

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 to use for indentation.

void XMLOutputter::setIndentLevel int    level [inline]
 

Set the initial indentation level.

Deprecated:
Deprecated in beta7, because this is better done with a stacked FilterOutputStream

void XMLOutputter::setIndentSize int    indentSize [inline]
 

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

Parameters:
indentSize  int number of spaces in indentation.

void XMLOutputter::setLineSeparator String    separator [inline]
 

This will set the newline separator (lineSeparator). The default is \r
. 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"))

To output "UNIX-style" documents, call setLineSeparator("
")
. To output "Mac-style" documents, call setLineSeparator("\r"). DOS-style documents use CR-LF ("\r
"), which is the default.

Note that this only applies to newlines generated by the outputter. If you parse an XML document that contains newlines embedded inside a text node, and you do not call setTextNormalize, then the newlines will be output verbatim, as "
" which is how parsers normalize them.

See also:
setNewlines(boolean) , setTextNormalize(boolean)
Parameters:
separator  String line separator to use.

void XMLOutputter::setNewlines boolean    newlines [inline]
 

Sets whether newlines (lineSeparator) should be printed.

See also:
setLineSeparator(String)
Parameters:
newlines  true indicates new lines should be printed, else new lines are ignored (compacted).

void XMLOutputter::setOmitDeclaration boolean    omitDeclaration [inline]
 

This will set whether the XML declaration (<?xml version="1.0"?>) will be omitted or not. It is common to omit this in uses such as SOAP and XML-RPC calls.

Parameters:
omitDeclaration  boolean indicating whether or not the XML declaration should be omitted.

void XMLOutputter::setOmitEncoding boolean    omitEncoding [inline]
 

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

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

void XMLOutputter::setPadText boolean    padText [inline]
 

Ensure that text immediately preceded by or followed by an element will be "padded" with a single space.

Deprecated:
Deprecated in beta7, because this is no longer necessary

void XMLOutputter::setSuppressDeclaration boolean    suppressDeclaration [inline]
 

This will set whether the XML declaration (<?xml version="1.0"?>) will be suppressed or not. It is common to suppress this in uses such as SOAP and XML-RPC calls.

Parameters:
suppressDeclaration  boolean indicating whether or not the XML declaration should be suppressed.
Deprecated:
Deprecated in beta7, use setOmitDeclaration() instead

void XMLOutputter::setTextNormalize boolean    textNormalize [inline]
 

This will set whether the text is output verbatim (false) or with whitespace normalized as per Element::getTextNormalize.

Default: false

Parameters:
textNormalize  boolean true=>normalize the whitespace, false=>use text verbatim

void XMLOutputter::setTextTrim boolean    textTrim [inline]
 

This will set whether the text has leading/trailing whitespace trimmed.

Default: false

Parameters:
textTrim  boolean true=>trim the leading/trailing whitespace, false=>use text verbatim

void XMLOutputter::setTrimAllWhite boolean    trimAllWhite [inline]
 

This will set whether content between tags consisting of all whitespace is printed or trimmed.

Default: false

Parameters:
trimAllWhite  boolean true=>content consisting of only whitespace is not print, false=>use text verbatim

String XMLOutputter::toString   [inline]
 

Return a string listing of the settings for this XMLOutputter instance.

Returns:
a string listing the settings for this XMLOutputter instance


The documentation for this class was generated from the following file:
Generated on Sat Mar 30 18:53:04 2002 for JDOM by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001