Package cdc.util.xml

Class XmlUtil

java.lang.Object

cdc.util.xml.XmlUtil

public final class XmlUtil
extends java.lang.Object

Xml utilities.

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlUtil.Context	Escaping context.
static class	XmlUtil.EscapingPolicy

Method Summary

Modifier and Type	Method	Description
static java.lang.String	escape(java.lang.String s, XmlUtil.Context context, XmlUtil.EscapingPolicy policy)	Returns an escaped version of a string.
static boolean	isIgnorableSpace(char c)	Returns true when a character is an ignorable space.
static boolean	isIgnorableSpace(char[] ch, int offset, int count)	Returns true when the characters in an array range are ignorable spaces.
static boolean	isIgnorableSpace(java.lang.String s)	Returns true when a string is is composed of ignorable spaces.
static boolean	needsEscape(java.lang.String s, XmlUtil.Context context, XmlUtil.EscapingPolicy policy)	Returns true is a string must be escaped.

Methods inherited from class java.lang.Object

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

Method Detail

isIgnorableSpace

public static boolean isIgnorableSpace(char c)

Returns true when a character is an ignorable space.

The character is ' ', '\t', '\n', '\r' or '\f'.

Parameters:

c - The character.

Returns:

true when c is an ignorable space.

isIgnorableSpace

public static boolean isIgnorableSpace(java.lang.String s)

Returns true when a string is is composed of ignorable spaces.

Parameters:

s - The string.

Returns:

true when s is composed of ignorable spaces.

isIgnorableSpace

public static boolean isIgnorableSpace(char[] ch,
                                       int offset,
                                       int count)

Returns true when the characters in an array range are ignorable spaces.

Parameters:

ch - The characters.

offset - Index of the first character to test.

count - Number of characters to test.

Returns:

true when the characters in [offset, offset+count[ are ignorable spaces.

needsEscape

public static boolean needsEscape(java.lang.String s,
                                  XmlUtil.Context context,
                                  XmlUtil.EscapingPolicy policy)

Returns true is a string must be escaped.

• < and & must always be escaped.
• > does not need escape. It is escaped if required with policy.
• " needs to be escaped in attributes delimited by ". Otherwise, is escaped if required by policy.
• ' needs to be escaped in attributes delimited by '. Otherwise, is escaped if required by policy.
• \t, \n and \r should be escaped in attributes. They are if escaped if required by policy.

Parameters:

s - The string.

context - The context.

policy - The escaping policy.

Returns:

true is s must be escaped incontext and using policy.

escape

public static java.lang.String escape(java.lang.String s,
                                      XmlUtil.Context context,
                                      XmlUtil.EscapingPolicy policy)

Returns an escaped version of a string.

Parameters:

s - The string.

context - The context.

policy - The escaping policy.

Returns:

The escaped version of s incontext and using policy.