appilog.common.utils.xml

Class XmlHelper

java.lang.Object

appilog.common.utils.xml.XmlHelper

public class XmlHelper
extends java.lang.Object

Author: Dima Rassin Date: Jun 29, 2003

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	XML_ENCODING

Constructor Summary

Constructors

Constructor and Description
XmlHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	checkElementText(java.lang.Object value)
static java.lang.String	closeElement(java.lang.String elementName) Returns a close tag of XML element
static java.lang.String	fixXMLString(java.lang.String string) Fixes a string for use in XML (replaces & with & < with > > with <
static java.lang.String	flatPrintXml(Element element)
static java.lang.String	getEncoding()
static java.lang.String	getEncoding(java.lang.String encoding)
static boolean	isByteValid(int aByte)
static boolean	isXMLCharacter(char c) This is a utility function for determining whether a specified character is a character according to production 2 of the XML 1.0 specification.
static Element	loadRootElement(java.io.InputStream inStream)
static Element	loadRootElement(java.lang.String xmlData) Parses XML string and returns its root element
static java.lang.String	makeElement(java.lang.String elementName) Builds string of empty XML element
static java.lang.String	makeElement(java.lang.String elementName, boolean value) Builds string of XML element
static java.lang.String	makeElement(java.lang.String elementName, int value) Builds string of XML element
static java.lang.String	makeElement(java.lang.String elementName, java.lang.Object value) Builds string of XML element
static java.lang.String	makeElement(java.lang.String elementName, java.lang.Object value, java.util.Collection attributes) Builds string of XML element
static java.lang.String	makeElement(java.lang.String elementName, java.lang.Object value, java.util.Map attributes) Builds string of XML element
static java.lang.String	openElement(java.lang.String elementName) Returns an open tag of XML element
static java.lang.String	openElement(java.lang.String elementName, java.util.Collection attributes) Returns an open tag of XML element
static java.lang.String	openElement(java.lang.String elementName, java.util.Map attributes) Returns an open tag of XML element
static java.lang.String	prettyPrintXml(Element element)
static java.lang.String	prettyPrintXml(Element element, boolean normalizeText)
static java.lang.String	prettyPrintXml(Element element, boolean normalizeText, boolean setNewLines)
static java.lang.String	prettyPrintXml(Element element, boolean normalizeText, boolean setIdent, boolean setNewLines)
static java.lang.String	toXmlString(Element element)
static java.lang.String	toXmlString(Element element, java.lang.String encoding)

Methods inherited from class java.lang.Object

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

Field Detail

XML_ENCODING

public static java.lang.String XML_ENCODING

Constructor Detail

XmlHelper

public XmlHelper()

Method Detail

checkElementText

public static java.lang.String checkElementText(java.lang.Object value)

isXMLCharacter

public static boolean isXMLCharacter(char c)

This is a utility function for determining whether a specified character is a character according to production 2 of the XML 1.0 specification.

Parameters:

c - char to check for XML compliance.

Returns:

boolean - true if it's a character, false otherwise.

makeElement

public static java.lang.String makeElement(java.lang.String elementName,
                           java.lang.Object value,
                           java.util.Map attributes)

Builds string of XML element

Parameters:

elementName - the element name

value - the element value

attributes - the table of element attributes

Returns:

the string represents XML element

makeElement

public static java.lang.String makeElement(java.lang.String elementName,
                           java.lang.Object value,
                           java.util.Collection attributes)

Builds string of XML element

Parameters:

elementName - the element name

value - the element value

attributes - the collection of element attributes

Returns:

the string represents XML element

makeElement

public static java.lang.String makeElement(java.lang.String elementName,
                           java.lang.Object value)

Builds string of XML element

Parameters:

elementName - the element name

value - the element value

Returns:

the string represents XML element

makeElement

public static java.lang.String makeElement(java.lang.String elementName,
                           int value)

Builds string of XML element

Parameters:

elementName - the element name

value - the element value

Returns:

the string represents XML element

makeElement

public static java.lang.String makeElement(java.lang.String elementName,
                           boolean value)

Builds string of XML element

Parameters:

elementName - the element name

value - the element value

Returns:

the string represents XML element

makeElement

public static java.lang.String makeElement(java.lang.String elementName)

Builds string of empty XML element

Parameters:

elementName - the element name

Returns:

the string represents XML element

openElement

public static java.lang.String openElement(java.lang.String elementName,
                           java.util.Map attributes)

Returns an open tag of XML element

Parameters:

elementName - the element name

attributes - the table of element attributes

Returns:

an open tag of XML element

openElement

public static java.lang.String openElement(java.lang.String elementName,
                           java.util.Collection attributes)

Returns an open tag of XML element

Parameters:

elementName - the element name

attributes - the collection of element attributes

Returns:

an open tag of XML element

openElement

public static java.lang.String openElement(java.lang.String elementName)

Returns an open tag of XML element

Parameters:

elementName - the element name

Returns:

an open tag of XML element

closeElement

public static java.lang.String closeElement(java.lang.String elementName)

Returns a close tag of XML element

Parameters:

elementName - the element name

Returns:

a close tag of XML element

getEncoding

public static java.lang.String getEncoding(java.lang.String encoding)

getEncoding

public static java.lang.String getEncoding()

toXmlString

public static java.lang.String toXmlString(Element element,
                           java.lang.String encoding)

toXmlString

public static java.lang.String toXmlString(Element element)

prettyPrintXml

public static java.lang.String prettyPrintXml(Element element)

prettyPrintXml

public static java.lang.String prettyPrintXml(Element element,
                              boolean normalizeText)

prettyPrintXml

public static java.lang.String prettyPrintXml(Element element,
                              boolean normalizeText,
                              boolean setNewLines)

prettyPrintXml

public static java.lang.String prettyPrintXml(Element element,
                              boolean normalizeText,
                              boolean setIdent,
                              boolean setNewLines)

flatPrintXml

public static java.lang.String flatPrintXml(Element element)

isByteValid

public static boolean isByteValid(int aByte)

fixXMLString

public static java.lang.String fixXMLString(java.lang.String string)

Fixes a string for use in XML (replaces & with & < with > > with <

Parameters:

string -

Returns:

Fixed XML version of the specified string

loadRootElement

public static Element loadRootElement(java.lang.String xmlData)
                               throws java.io.IOException,
                                      JDOMException

Parses XML string and returns its root element

Parameters:

xmlData - xml data to parse

Returns:

the XML's root element

Throws:

java.io.IOException

JDOMException

loadRootElement

public static Element loadRootElement(java.io.InputStream inStream)
                               throws java.io.IOException,
                                      JDOMException

Throws:

java.io.IOException

JDOMException