com.tridion.util.xml

Class DOMElementWriter

java.lang.Object

com.tridion.util.xml.DOMElementWriter

public class DOMElementWriter
extends Object

Writes a DOM tree to a given Writer.

Constructor Summary

Constructors

Constructor and Description
DOMElementWriter()

Method Summary

Modifier and Type	Method and Description
String	encode(String value) Escape <, > & ', " as their entities and drop characters that are illegal in XML documents.
String	encodedata(String value) Drop characters that are illegal in XML documents.
boolean	isLegalCharacter(char c) Is the given character allowed inside an XML document?
boolean	isReference(String ent) Is the given argument a character or entity reference?
void	write(Element root, OutputStream out) Writes a DOM tree to a stream in UTF8 encoding.
void	write(Element element, Writer out, int indent, String indentWith) Writes a DOM tree to a stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DOMElementWriter

public DOMElementWriter()

Method Detail

write

public void write(Element root,
                  OutputStream out)
           throws IOException

Writes a DOM tree to a stream in UTF8 encoding. Note that it appends the <?xml version='1.0' encoding='UTF-8'?>. The indent number is set to 0 and a 2-space indent.

Parameters:

root - the root element of the DOM tree.

out - the outputstream to write to.

Throws:

IOException - if an error happens while writing to the stream.

write

public void write(Element element,
                  Writer out,
                  int indent,
                  String indentWith)
           throws IOException

Writes a DOM tree to a stream.

Parameters:

element - the Root DOM element of the tree

out - where to send the output

indent - number of

indentWith - string that should be used to indent the corresponding tag.

Throws:

IOException - if an error happens while writing to the stream.

encode

public String encode(String value)

Escape <, > & ', " as their entities and drop characters that are illegal in XML documents.

encodedata

public String encodedata(String value)

Drop characters that are illegal in XML documents.

See XML 1.0 2.2 http://www.w3.org/TR/1998/REC-xml-19980210#charsets.

isReference

public boolean isReference(String ent)

Is the given argument a character or entity reference?

isLegalCharacter

public boolean isLegalCharacter(char c)

Is the given character allowed inside an XML document?

See XML 1.0 2.2 http://www.w3.org/TR/1998/REC-xml-19980210#charsets.

Since:

1.10, Ant 1.5