org.zkoss.xml

Class XMLs

java.lang.Object

org.zkoss.xml.XMLs

public class XMLs
extends Object

The XML relevant utilities.

Author:

tomyeh

See Also:

Element

Constructor Summary

Constructors

Constructor and Description
XMLs()

Method Summary

Modifier and Type	Method and Description
static String	encodeAttribute(String value) Encodes a value such that it could be used as XML attribute.
static String	encodeText(String value) Encodes a value such that it could be enclosed by an XML element.
static StringBuffer	encodeText(StringBuffer sb, String value) Encodes a value and appends it to a string buffer, such that it could be enclosed by an XML element.
static StringBuffer	encodeText(StringBuffer sb, String value, int begin, int end) Encodes a value of the specified range, and appends it to a string buffer, such that it could be enclosed by an XML element.
static String	escapeXML(char cc) Escapes a character into a string if it is a special XML character, returns null if not a special character.
static String	escapeXML(String s) Encodes a string that special characters are quoted to be compatible with HTML/XML.
static String	toXMLName(String name) Converting a name to a valid XML name.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLs

public XMLs()

Method Detail

toXMLName

public static final String toXMLName(String name)

Converting a name to a valid XML name. Note: it is not reversible.

encodeAttribute

public static final String encodeAttribute(String value)

Encodes a value such that it could be used as XML attribute.

encodeText

public static final String encodeText(String value)

Encodes a value such that it could be enclosed by an XML element.

Note: It is sometime improper to use CDATA if the text contains CDATA, too. The simplest way is NOT to use CDATA but encoding the string by this method.

encodeText

public static final StringBuffer encodeText(StringBuffer sb,
                                            String value)

Encodes a value and appends it to a string buffer, such that it could be enclosed by an XML element.

Note: It is sometime improper to use CDATA if the text contains CDATA, too. The simplest way is NOT to use CDATA but encoding the string by this method.

encodeText

public static final StringBuffer encodeText(StringBuffer sb,
                                            String value,
                                            int begin,
                                            int end)

Encodes a value of the specified range, and appends it to a string buffer, such that it could be enclosed by an XML element.

Note: It is sometime improper to use CDATA if the text contains CDATA, too. The simplest way is NOT to use CDATA but encoding the string by this method.

Parameters:

value - the string to encode

begin - the beginning index, inclusive of the string to encode (i.e., value), included

end - the ending index, exclusive of the string to encode (i.e., value), excluded

Since:

5.0.0

escapeXML

public static final String escapeXML(String s)

Encodes a string that special characters are quoted to be compatible with HTML/XML. For example, < is translated to &lt;. & -> &amp;
< -> &lt;
> -> &gt;
" -> &#034;
' -> &#039;

Parameters:

s - the string to quote; null is OK

Returns:

the escaped string, or an empty string if s is null

escapeXML

public static final String escapeXML(char cc)

Escapes a character into a string if it is a special XML character, returns null if not a special character. & -> &amp;
< -> &lt;
> -> &gt;
" -> &#034;
' -> &#039;