|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jdom.output.XMLOutputter
public class XMLOutputter
Outputs a JDOM document as a stream of bytes. 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
by setting a new Format object. For pretty-print output, use
. For whitespace-normalized
output, use Format.getPrettyFormat()
.
Format.getCompactFormat()
There are
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 Format object. 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 Format
manually in its constructor or via the
output(...)
method. The default encoding is
UTF-8.
Format.setEncoding(java.lang.String)
The methods
are for
convenience only; for top performance you should call one of the outputString(...)
methods and pass in your own Writer or
OutputStream if possible.
output(...)
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
. To omit printing of the
encoding in the declaration use Format.setOmitDeclaration(boolean)
.
Unfortunatly there is currently no way to know the original encoding of the
document.
Format.setOmitEncoding(boolean)
Empty elements are by default printed as <empty/>, but this can be
configured with
to cause
them to be expanded to <empty></empty>.
Format.setExpandEmptyElements(boolean)
Constructor Summary | |
---|---|
XMLOutputter()
This will create an XMLOutputter with the default
Format matching Format.getRawFormat() . |
|
XMLOutputter(Format format)
This will create an XMLOutputter with the specified
format characteristics. |
|
XMLOutputter(XMLOutputter that)
This will create an XMLOutputter with all the
options as set in the given XMLOutputter . |
Method Summary | |
---|---|
java.lang.Object |
clone()
Returns a copy of this XMLOutputter. |
java.lang.String |
escapeAttributeEntities(java.lang.String str)
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. |
java.lang.String |
escapeElementEntities(java.lang.String str)
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. |
Format |
getFormat()
Returns the current format in use by the outputter. |
void |
output(CDATA cdata,
java.io.OutputStream out)
Print out a node. |
void |
output(CDATA cdata,
java.io.Writer out)
Print out a node. |
void |
output(Comment comment,
java.io.OutputStream out)
Print out a . |
void |
output(Comment comment,
java.io.Writer out)
Print out a . |
void |
output(DocType doctype,
java.io.OutputStream out)
Print out the . |
void |
output(DocType doctype,
java.io.Writer out)
Print out the . |
void |
output(Document doc,
java.io.OutputStream out)
This will print the Document to the given output stream. |
void |
output(Document doc,
java.io.Writer out)
This will print the Document to the given Writer. |
void |
output(Element element,
java.io.OutputStream out)
Print out an , including
its s, and all
contained (child) elements, etc. |
void |
output(Element element,
java.io.Writer out)
Print out an , including
its s, and all
contained (child) elements, etc. |
void |
output(EntityRef entity,
java.io.OutputStream out)
Print out a . |
void |
output(EntityRef entity,
java.io.Writer out)
Print out a . |
void |
output(java.util.List list,
java.io.OutputStream out)
This will handle printing out a list of nodes. |
void |
output(java.util.List list,
java.io.Writer out)
This will handle printing out a list of nodes. |
void |
output(ProcessingInstruction pi,
java.io.OutputStream out)
Print out a . |
void |
output(ProcessingInstruction pi,
java.io.Writer out)
Print out a . |
void |
output(Text text,
java.io.OutputStream out)
Print out a node. |
void |
output(Text text,
java.io.Writer out)
Print out a node. |
void |
outputElementContent(Element element,
java.io.OutputStream out)
This will handle printing out an 's content only, not including its tag, and
attributes. |
void |
outputElementContent(Element element,
java.io.Writer out)
This will handle printing out an 's content only, not including its tag, and
attributes. |
java.lang.String |
outputString(CDATA cdata)
Return a string representing a CDATA node. |
java.lang.String |
outputString(Comment comment)
Return a string representing a comment. |
java.lang.String |
outputString(DocType doctype)
Return a string representing a DocType. |
java.lang.String |
outputString(Document doc)
Return a string representing a document. |
java.lang.String |
outputString(Element element)
Return a string representing an element. |
java.lang.String |
outputString(EntityRef entity)
Return a string representing an entity. |
java.lang.String |
outputString(java.util.List list)
Return a string representing a list of nodes. |
java.lang.String |
outputString(ProcessingInstruction pi)
Return a string representing a PI. |
java.lang.String |
outputString(Text text)
Return a string representing a Text node. |
void |
setFormat(Format newFormat)
Sets the new format logic for the outputter. |
java.lang.String |
toString()
Return a string listing of the settings for this XMLOutputter instance. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public XMLOutputter()
XMLOutputter
with the default
Format
matching Format.getRawFormat()
.
public XMLOutputter(Format format)
XMLOutputter
with the specified
format characteristics. Note the format object is cloned internally
before use.
public XMLOutputter(XMLOutputter that)
XMLOutputter
with all the
options as set in the given XMLOutputter
. Note
that XMLOutputter two = (XMLOutputter)one.clone();
would work equally well.
that
- the XMLOutputter to cloneMethod Detail |
---|
public void setFormat(Format newFormat)
newFormat
- the format to use for outputpublic Format getFormat()
public void output(Document doc, java.io.OutputStream out) throws java.io.IOException
Document
to the given output stream.
The characters are printed using the encoding specified in the
constructor, or a default of UTF-8.
doc
- Document
to format.out
- OutputStream
to use.
java.io.IOException
- - if there's any problem writing.public void output(DocType doctype, java.io.OutputStream out) throws java.io.IOException
DocType
.
doctype
- DocType
to output.out
- OutputStream
to use.
java.io.IOException
public void output(Element element, java.io.OutputStream out) throws java.io.IOException
Element
, including
its Attribute
s, and all
contained (child) elements, etc.
element
- Element
to output.out
- Writer
to use.
java.io.IOException
public void outputElementContent(Element element, java.io.OutputStream out) throws java.io.IOException
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>".
element
- Element
to output.out
- OutputStream
to use.
java.io.IOException
public void output(java.util.List list, java.io.OutputStream out) throws java.io.IOException
list
- List
of nodes.out
- OutputStream
to use.
java.io.IOException
public void output(CDATA cdata, java.io.OutputStream out) throws java.io.IOException
CDATA
node.
cdata
- CDATA
to output.out
- OutputStream
to use.
java.io.IOException
public void output(Text text, java.io.OutputStream out) throws java.io.IOException
Text
node. Perfoms
the necessary entity escaping and whitespace stripping.
text
- Text
to output.out
- OutputStream
to use.
java.io.IOException
public void output(Comment comment, java.io.OutputStream out) throws java.io.IOException
Comment
.
comment
- Comment
to output.out
- OutputStream
to use.
java.io.IOException
public void output(ProcessingInstruction pi, java.io.OutputStream out) throws java.io.IOException
ProcessingInstruction
.
pi
- ProcessingInstruction
to output.out
- OutputStream
to use.
java.io.IOException
public void output(EntityRef entity, java.io.OutputStream out) throws java.io.IOException
EntityRef
.
entity
- EntityRef
to output.out
- OutputStream
to use.
java.io.IOException
public void output(Document doc, java.io.Writer out) throws java.io.IOException
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.
doc
- Document
to format.out
- Writer
to use.
java.io.IOException
- - if there's any problem writing.public void output(DocType doctype, java.io.Writer out) throws java.io.IOException
DocType
.
doctype
- DocType
to output.out
- Writer
to use.
java.io.IOException
public void output(Element element, java.io.Writer out) throws java.io.IOException
Element
, including
its Attribute
s, and all
contained (child) elements, etc.
element
- Element
to output.out
- Writer
to use.
java.io.IOException
public void outputElementContent(Element element, java.io.Writer out) throws java.io.IOException
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>".
element
- Element
to output.out
- Writer
to use.
java.io.IOException
public void output(java.util.List list, java.io.Writer out) throws java.io.IOException
list
- List
of nodes.out
- Writer
to use.
java.io.IOException
public void output(CDATA cdata, java.io.Writer out) throws java.io.IOException
CDATA
node.
cdata
- CDATA
to output.out
- Writer
to use.
java.io.IOException
public void output(Text text, java.io.Writer out) throws java.io.IOException
Text
node. Perfoms
the necessary entity escaping and whitespace stripping.
text
- Text
to output.out
- Writer
to use.
java.io.IOException
public void output(Comment comment, java.io.Writer out) throws java.io.IOException
Comment
.
comment
- Comment
to output.out
- Writer
to use.
java.io.IOException
public void output(ProcessingInstruction pi, java.io.Writer out) throws java.io.IOException
ProcessingInstruction
.
pi
- ProcessingInstruction
to output.out
- Writer
to use.
java.io.IOException
public void output(EntityRef entity, java.io.Writer out) throws java.io.IOException
EntityRef
.
entity
- EntityRef
to output.out
- Writer
to use.
java.io.IOException
public java.lang.String outputString(Document doc)
doc
- Document
to format.public java.lang.String outputString(DocType doctype)
doctype
- DocType
to format.public java.lang.String outputString(Element element)
element
- Element
to format.public java.lang.String outputString(java.util.List list)
list
- List
to format.public java.lang.String outputString(CDATA cdata)
cdata
- CDATA
to format.public java.lang.String outputString(Text text)
text
- Text
to format.public java.lang.String outputString(Comment comment)
comment
- Comment
to format.public java.lang.String outputString(ProcessingInstruction pi)
pi
- ProcessingInstruction
to format.public java.lang.String outputString(EntityRef entity)
entity
- EntityRef
to format.public java.lang.String escapeAttributeEntities(java.lang.String str)
str
- String
input to escape.
String
with escaped content.public java.lang.String escapeElementEntities(java.lang.String str)
str
- String
input to escape.
String
with escaped content.public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |