com.novell.emframe.dev

Class XmlUtils

java.lang.Object

com.novell.emframe.dev.XmlUtils

public class XmlUtils
extends java.lang.Object

Provides a set of static utility methods for generating XML data to an output stream.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CDATA_END Character data section end.
static java.lang.String	CDATA_START Character data section start.
static java.lang.String	EMPTY_STRING

Constructor Summary

Constructors

Constructor and Description
XmlUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	stringToXML(java.lang.String str) Escapes chars for use in XML.
static void	writeCDataTag(java.lang.String tagName, java.lang.String tagValue, java.io.BufferedWriter bout) Writes an entire XML element (without attributes) to the output stream - the data value is enclosed in a CDATA section.
static void	writeCDataTag(java.lang.String tagName, java.lang.String tagValue, java.lang.StringBuffer bout) Writes an entire XML element (without attributes) to the StringBuffer - the data value is enclosed in a CDATA section.
static void	writeEndTag(java.lang.String tagName, java.io.BufferedWriter bout) Writes an XML end tag to the output stream.
static void	writeEndTag(java.lang.String tagName, java.lang.StringBuffer bout) Writes an XML end tag to the StringBuffer.
static void	writeStartTag(java.lang.String tagName, java.io.BufferedWriter bout) Writes an XML start tag (without attributes) to the output stream.
static void	writeStartTag(java.lang.String tagName, java.util.Properties tagAttributes, java.io.BufferedWriter bout) Writes an XML start tag and associated attributes to the output stream.
static void	writeStartTag(java.lang.String tagName, java.util.Properties tagAttributes, java.lang.StringBuffer bout) Writes an XML start tag and associated attributes to the StringBuffer.
static void	writeStartTag(java.lang.String tagName, java.lang.StringBuffer bout) Writes an XML start tag (without attributes) to the StringBuffer.
static void	writeTag(java.lang.String tagName, java.util.Properties tagAttributes, java.lang.String tagValue, java.io.BufferedWriter bout) Writes an entire XML element with attributes to the output stream.
static void	writeTag(java.lang.String tagName, java.util.Properties tagAttributes, java.lang.String tagValue, java.io.BufferedWriter bout, boolean bCData) Writes an entire XML element to the output stream - the data value is optionally enclosed in a CDATA section.
static void	writeTag(java.lang.String tagName, java.util.Properties tagAttributes, java.lang.String tagValue, java.lang.StringBuffer bout) Writes an entire XML element to the StringBuffer.
static void	writeTag(java.lang.String tagName, java.util.Properties tagAttributes, java.lang.String tagValue, java.lang.StringBuffer bout, boolean bCData) Writes an entire XML element to the StringBuffer - the data value is optionally enclosed in a CDATA section.
static void	writeTag(java.lang.String tagName, java.lang.String tagValue, java.io.BufferedWriter bout) Writes an entire XML element (without attributes) to the output stream.
static void	writeTag(java.lang.String tagName, java.lang.String tagValue, java.lang.StringBuffer bout) Writes an entire XML element (without attributes) to the StringBuffer.
static java.lang.String	xmlDecode(java.lang.String str) Decodes string that has been escape for XML.
static java.lang.String	xmlDocumentToString(org.jdom.Document doc) Convert a XML Document object to a String
static java.lang.String	xmlDocumentToString(org.w3c.dom.Document doc) Convert a XML Document object to a String
static java.lang.String	xmlElementToString(org.w3c.dom.Element element) Convert a XML Document object to a String
static java.lang.String	xmlElementToString(org.jdom.Element element) Convert a XML Document object to a String
static java.lang.String	xmlEncode(java.lang.String strText) Escapes chars for use in XML.

Methods inherited from class java.lang.Object

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

Field Detail

CDATA_START

public static final java.lang.String CDATA_START

Character data section start.

( CDATA_START = "<![CDATA[" )

See Also:

Constant Field Values

CDATA_END

public static final java.lang.String CDATA_END

Character data section end.

CDATA_END = "]]>"

See Also:

Constant Field Values

EMPTY_STRING

public static final java.lang.String EMPTY_STRING

Constructor Detail

XmlUtils

public XmlUtils()

Method Detail

writeTag

public static void writeTag(java.lang.String tagName,
                            java.lang.String tagValue,
                            java.io.BufferedWriter bout)
                     throws java.io.IOException

Writes an entire XML element (without attributes) to the output stream.

Sample output:
<tagName>tagValue</tagName>

Parameters:

tagName - the tag name

tagValue - the element data, may be null

bout - the output stream

Throws:

java.io.IOException - on I/O error

writeCDataTag

public static void writeCDataTag(java.lang.String tagName,
                                 java.lang.String tagValue,
                                 java.io.BufferedWriter bout)
                          throws java.io.IOException

Writes an entire XML element (without attributes) to the output stream - the data value is enclosed in a CDATA section.

Sample output:
<tagName><![CDATA[tagValue]]></tagName>

Parameters:

tagName - the tag name

tagValue - the element data, may be null

bout - the output stream

Throws:

java.io.IOException - on I/O error

writeTag

public static void writeTag(java.lang.String tagName,
                            java.util.Properties tagAttributes,
                            java.lang.String tagValue,
                            java.io.BufferedWriter bout)
                     throws java.io.IOException

Writes an entire XML element with attributes to the output stream.

Sample output:
<tagName attr1="val1" attr2="val2" ...>tagValue</tagName>

Parameters:

tagName - the tag name

tagAttributes - a Properties object holding the attribute name/value pairs, may be null if no attributes

tagValue - the element data, may be null

bout - the output stream

Throws:

java.io.IOException - on I/O error

writeTag

public static void writeTag(java.lang.String tagName,
                            java.util.Properties tagAttributes,
                            java.lang.String tagValue,
                            java.io.BufferedWriter bout,
                            boolean bCData)
                     throws java.io.IOException

Writes an entire XML element to the output stream - the data value is optionally enclosed in a CDATA section.

Sample output:
<tagName attr1="val1" attr2="val2" ...>tagValue</tagName>
or
<tagName attr1="val1" attr2="val2" ...><![CDATA[tagValue]]></tagName>

Parameters:

tagName - the tag name

tagAttributes - a Properties object holding the attribute name/value pairs, may be null if no attributes

tagValue - the element data, may be null

bout - the output stream

bCData - true if the tagValue data requires a "<![CDATA[. . .]]>" wrapper

Throws:

java.io.IOException - on I/O error

writeStartTag

public static void writeStartTag(java.lang.String tagName,
                                 java.io.BufferedWriter bout)
                          throws java.io.IOException

Writes an XML start tag (without attributes) to the output stream.

Sample output:
<tagName>

Parameters:

tagName - the tag name

bout - the output stream

Throws:

java.io.IOException - on I/O error

writeStartTag

public static void writeStartTag(java.lang.String tagName,
                                 java.util.Properties tagAttributes,
                                 java.io.BufferedWriter bout)
                          throws java.io.IOException

Writes an XML start tag and associated attributes to the output stream.

Sample output:
<tagName attr1="val1" attr2="val2" ...>

Parameters:

tagName - the tag name

tagAttributes - a Properties object holding the attribute name/value pairs, may be null if no attributes

bout - the output stream

Throws:

java.io.IOException - on I/O error

writeEndTag

public static void writeEndTag(java.lang.String tagName,
                               java.io.BufferedWriter bout)
                        throws java.io.IOException

Writes an XML end tag to the output stream.

Sample output:
</tagName>

Parameters:

tagName - the tag name

bout - the output stream

Throws:

java.io.IOException - on I/O error

writeTag

public static void writeTag(java.lang.String tagName,
                            java.lang.String tagValue,
                            java.lang.StringBuffer bout)

Writes an entire XML element (without attributes) to the StringBuffer.

Sample output:
<tagName>tagValue</tagName>

Parameters:

tagName - the tag name

tagValue - the element data, may be null

bout - the StringBuffer

writeCDataTag

public static void writeCDataTag(java.lang.String tagName,
                                 java.lang.String tagValue,
                                 java.lang.StringBuffer bout)

Writes an entire XML element (without attributes) to the StringBuffer - the data value is enclosed in a CDATA section.

Sample output:
<tagName><![CDATA[tagValue]]></tagName>

Parameters:

tagName - the tag name

tagValue - the element data, may be null

bout - the StringBuffer

writeTag

public static void writeTag(java.lang.String tagName,
                            java.util.Properties tagAttributes,
                            java.lang.String tagValue,
                            java.lang.StringBuffer bout)

Writes an entire XML element to the StringBuffer.

Sample output:
<tagName attr1="val1" attr2="val2" ...>tagValue</tagName>

Parameters:

tagName - the tag name

tagAttributes - a Properties object holding the attribute name/value pairs, may be null if no attributes

tagValue - the element data, may be null

bout - the StringBuffer

writeTag

public static void writeTag(java.lang.String tagName,
                            java.util.Properties tagAttributes,
                            java.lang.String tagValue,
                            java.lang.StringBuffer bout,
                            boolean bCData)

Writes an entire XML element to the StringBuffer - the data value is optionally enclosed in a CDATA section.

Sample output:
<tagName attr1="val1" attr2="val2" ...>tagValue</tagName>
or
<tagName attr1="val1" attr2="val2" ...><![CDATA[tagValue]]></tagName>

Parameters:

tagName - the tag name

tagAttributes - a Properties object holding the attribute name/value pairs, may be null if no attributes

tagValue - the element data, may be null

bout - the StringBuffer

bCData - true if the tagValue data requires a "<![CDATA[. . .]]>" wrapper

writeStartTag

public static void writeStartTag(java.lang.String tagName,
                                 java.lang.StringBuffer bout)

Writes an XML start tag (without attributes) to the StringBuffer.

Sample output:
<tagName>

Parameters:

tagName - the tag name

bout - the StringBuffer

writeStartTag

public static void writeStartTag(java.lang.String tagName,
                                 java.util.Properties tagAttributes,
                                 java.lang.StringBuffer bout)

Writes an XML start tag and associated attributes to the StringBuffer.

Sample output:
<tagName attr1="val1" attr2="val2" ...>

Parameters:

tagName - the tag name

tagAttributes - a Properties object holding the attribute name/value pairs, may be null if no attributes

bout - the StringBuffer

writeEndTag

public static void writeEndTag(java.lang.String tagName,
                               java.lang.StringBuffer bout)

Writes an XML end tag to the StringBuffer.

Sample output:
</tagName>

Parameters:

tagName - the tag name

bout - the StringBuffer

xmlDocumentToString

public static java.lang.String xmlDocumentToString(org.jdom.Document doc)

Convert a XML Document object to a String

Parameters:

Document - XML Document to convert to a String

Returns:

String representation of the XML Document

Since:

2.6

xmlDocumentToString

public static java.lang.String xmlDocumentToString(org.w3c.dom.Document doc)

Convert a XML Document object to a String

Parameters:

Document - XML Document to convert to a String

Returns:

String representation of the XML Document

Since:

2.6

xmlElementToString

public static java.lang.String xmlElementToString(org.w3c.dom.Element element)

Convert a XML Document object to a String

Parameters:

Document - XML Document to convert to a String

Returns:

String representation of the XML Document

Since:

2.6

xmlElementToString

public static java.lang.String xmlElementToString(org.jdom.Element element)

Convert a XML Document object to a String

Parameters:

Document - XML Document to convert to a String

Returns:

String representation of the XML Document

Since:

2.6

xmlDecode

public static java.lang.String xmlDecode(java.lang.String str)

Decodes string that has been escape for XML.

Parameters:

str - String to decode

Returns:

Decoded String

xmlEncode

public static java.lang.String xmlEncode(java.lang.String strText)

Escapes chars for use in XML.

Parameters:

strText - String to escape

Returns:

String safe for use in XML

stringToXML

public static java.lang.String stringToXML(java.lang.String str)

Escapes chars for use in XML.

Parameters:

str - String to escape

Returns:

String safe for use in XML