com.hfg.xml

Class XMLUtil

java.lang.Object

com.hfg.xml.XMLUtil

public class XMLUtil
extends java.lang.Object

Helper class with static methods for XML tag constrution and some parser helper methods.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE64
static java.lang.String	COMPRESSION_ATT
static boolean	EMPTY_TAG Constant which can be used with composeStartTag().
static java.lang.String	ENCODING_ATT
static java.lang.String	GZIP
static boolean	NOT_EMPTY_TAG Constant which can be used with composeStartTag().
static java.util.regex.Pattern	sEntityPattern2

Constructor Summary

Constructors

Constructor and Description
XMLUtil()

Method Summary

Modifier and Type	Method and Description
static void	checkXMLNameValidity(java.lang.String inValue) Is the tag or element name valid?
static java.lang.String	composeEndTag(java.lang.String inName) Composes an xml end tag (ex: "</inName>").
static java.lang.String	composeStartTag(java.lang.String inName) Composes an xml start tag (ex: "<inName>").
static java.lang.String	composeStartTag(java.lang.String inName, org.xml.sax.Attributes inAttributes) Composes an xml start tag (ex: "<inName att1='value1' att2='value2'>").
static java.lang.String	composeStartTag(java.lang.String inName, org.xml.sax.Attributes inAttributes, boolean isEmptyTag) Composes an xml start tag (ex: "<inName att1='value1' att2='value2'>").
static java.lang.String	composeStartTag(java.lang.String inName, java.util.Collection<XMLAttribute> inAttributes) Composes an xml start tag (ex: "<inName att1='value1' att2='value2'>").
static java.lang.String	composeStartTag(java.lang.String inName, java.util.Collection<XMLAttribute> inAttributes, boolean isEmptyTag) Composes an xml start tag (ex: "<inName att1='value1' att2='value2'>").
static java.lang.String	composeStartTag(java.lang.String inName, java.util.Map<java.lang.String,java.lang.Object> inAttributes) Composes an xml start tag (ex: "<inName att1='value1' att2='value2'>").
static java.lang.String	composeStartTag(java.lang.String inName, java.util.Map<java.lang.String,java.lang.Object> inAttributes, boolean isEmptyTag) Composes an xml start tag (ex: "<inName att1='value1' att2='value2'>").
static java.lang.String	convertCharacterEntitiesToNumeric(java.lang.String inContent)
static java.lang.String	convertCharacterEntitiesToUnicode(java.lang.String inContent)
static java.lang.String	escapeAmp(java.lang.String inAttributeValue)
static java.lang.String	escapeApos(java.lang.String inAttributeValue)
static java.lang.String	escapeAttributeValue(java.lang.String inAttributeValue)
static java.lang.String	escapeContent(java.lang.String inContent)
static java.lang.String	escapeContentIfNecessary(java.lang.String inContent) Makes the content XML safe by ensuring that all '<'s are all escaped and that all '&'s are part of an entity.
static java.lang.String	escapeDoubleQuotedAttributeValue(java.lang.String inAttributeValue)
static java.lang.String	escapeQuote(java.lang.String inAttributeValue)
static java.util.List<XMLNode>	findNodesByAttribute(XMLNode inRootNode, java.lang.String inAttribute)
static java.util.List<XMLNode>	findNodesByAttribute(XMLNode inRootNode, XMLAttribute inAttribute)
static boolean	isWellFormedContentFragment(java.lang.String inXML) Returns whether or not the content fragment is well-formed and if tags are present internal to the fragment, whether the tag section and preceding or trailing raw content is well-formed.
static boolean	isWellFormedFragment(java.lang.String inXML)
static java.lang.String	replaceUnicodeWithEntities(java.lang.String inString)
static java.lang.String	unescapeAttributeValue(java.lang.String inAttributeValue)
static java.lang.String	unescapeContent(java.lang.String inContent)
static java.lang.String	unescapeEntities(java.lang.String inValue)
static void	useDoubleQuotes(boolean inValue) Set whether to use double quotes or single quotes for attribute values.

Methods inherited from class java.lang.Object

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

Field Detail

COMPRESSION_ATT

public static final java.lang.String COMPRESSION_ATT

See Also:

Constant Field Values

GZIP

public static final java.lang.String GZIP

See Also:

Constant Field Values

ENCODING_ATT

public static final java.lang.String ENCODING_ATT

See Also:

Constant Field Values

BASE64

public static final java.lang.String BASE64

See Also:

Constant Field Values

EMPTY_TAG

public static final boolean EMPTY_TAG

Constant which can be used with composeStartTag().

See Also:

Constant Field Values

NOT_EMPTY_TAG

public static final boolean NOT_EMPTY_TAG

Constant which can be used with composeStartTag().

See Also:

Constant Field Values

sEntityPattern2

public static java.util.regex.Pattern sEntityPattern2

Constructor Detail

XMLUtil

public XMLUtil()

Method Detail

useDoubleQuotes

public static void useDoubleQuotes(boolean inValue)

Set whether to use double quotes or single quotes for attribute values. Single quotes are used by default.

composeStartTag

public static java.lang.String composeStartTag(java.lang.String inName)

Composes an xml start tag (ex: "<inName>").

composeStartTag

public static java.lang.String composeStartTag(java.lang.String inName,
                                               org.xml.sax.Attributes inAttributes)

Composes an xml start tag (ex: "<inName att1='value1' att2='value2'>"). Attributes appear in alphabetical order for consistency.

composeStartTag

public static java.lang.String composeStartTag(java.lang.String inName,
                                               org.xml.sax.Attributes inAttributes,
                                               boolean isEmptyTag)

Composes an xml start tag (ex: "<inName att1='value1' att2='value2'>"). Attributes appear in alphabetical order for consistency.

composeStartTag

public static java.lang.String composeStartTag(java.lang.String inName,
                                               java.util.Collection<XMLAttribute> inAttributes)

Composes an xml start tag (ex: "<inName att1='value1' att2='value2'>"). Attributes appear in alphabetical order for consistency.

composeStartTag

public static java.lang.String composeStartTag(java.lang.String inName,
                                               java.util.Collection<XMLAttribute> inAttributes,
                                               boolean isEmptyTag)

Composes an xml start tag (ex: "<inName att1='value1' att2='value2'>"). If the isEmptyTag parameter is true, the output tag will end with "/>". ex: "<inName att1='value1' att2='value2'/>". Attributes appear in alphabetical order for consistency.

Parameters:

inName - the tag name

inAttributes - a List of XMLAttribute objects

isEmptyTag - whether or not the tag has any content or subtags

composeStartTag

public static java.lang.String composeStartTag(java.lang.String inName,
                                               java.util.Map<java.lang.String,java.lang.Object> inAttributes)

Composes an xml start tag (ex: "<inName att1='value1' att2='value2'>"). Attributes appear in alphabetical order for consistency.

composeStartTag

public static java.lang.String composeStartTag(java.lang.String inName,
                                               java.util.Map<java.lang.String,java.lang.Object> inAttributes,
                                               boolean isEmptyTag)

Composes an xml start tag (ex: "<inName att1='value1' att2='value2'>"). If the isEmptyTag parameter is true, the output tag will end with "/>". ex: "<inName att1='value1' att2='value2'/>". Attributes appear in alphabetical order for consistency.

composeEndTag

public static java.lang.String composeEndTag(java.lang.String inName)

Composes an xml end tag (ex: "</inName>").

isWellFormedFragment

public static boolean isWellFormedFragment(java.lang.String inXML)

isWellFormedContentFragment

public static boolean isWellFormedContentFragment(java.lang.String inXML)

Returns whether or not the content fragment is well-formed and if tags are present internal to the fragment, whether the tag section and preceding or trailing raw content is well-formed.

    Examples of valid content fragments:  '<foo />', 'foo &amp; bar', 'foo', 'foo <bar>1</bar> one'
    Examples of invalid content fragments:  '<foo>', 'foo & bar', 'foo <bar>1</zoot> one'
    

convertCharacterEntitiesToNumeric

public static java.lang.String convertCharacterEntitiesToNumeric(java.lang.String inContent)

convertCharacterEntitiesToUnicode

public static java.lang.String convertCharacterEntitiesToUnicode(java.lang.String inContent)

escapeContentIfNecessary

public static java.lang.String escapeContentIfNecessary(java.lang.String inContent)

Makes the content XML safe by ensuring that all '<'s are all escaped and that all '&'s are part of an entity. Avoids double escaping.

Parameters:

inContent -

Returns:

XML-safe content string

escapeContent

public static java.lang.String escapeContent(java.lang.String inContent)

unescapeContent

public static java.lang.String unescapeContent(java.lang.String inContent)

escapeAttributeValue

public static java.lang.String escapeAttributeValue(java.lang.String inAttributeValue)

unescapeAttributeValue

public static java.lang.String unescapeAttributeValue(java.lang.String inAttributeValue)

escapeApos

public static java.lang.String escapeApos(java.lang.String inAttributeValue)

escapeQuote

public static java.lang.String escapeQuote(java.lang.String inAttributeValue)

escapeAmp

public static java.lang.String escapeAmp(java.lang.String inAttributeValue)

unescapeEntities

public static java.lang.String unescapeEntities(java.lang.String inValue)

checkXMLNameValidity

public static void checkXMLNameValidity(java.lang.String inValue)
                                 throws com.hfg.xml.InvalidXMLNameException

Is the tag or element name valid?

Throws:

com.hfg.xml.InvalidXMLNameException

findNodesByAttribute

public static java.util.List<XMLNode> findNodesByAttribute(XMLNode inRootNode,
                                                           XMLAttribute inAttribute)

findNodesByAttribute

public static java.util.List<XMLNode> findNodesByAttribute(XMLNode inRootNode,
                                                           java.lang.String inAttribute)

escapeDoubleQuotedAttributeValue

public static java.lang.String escapeDoubleQuotedAttributeValue(java.lang.String inAttributeValue)

replaceUnicodeWithEntities

public static java.lang.String replaceUnicodeWithEntities(java.lang.String inString)