com.alipay.api.internal.util

Class XmlUtils

java.lang.Object

com.alipay.api.internal.util.XmlUtils

public final class XmlUtils
extends Object

Encapsulating XML common operations.

Since:

1.0, Jun 12, 2007

Author:

carver

Constructor Summary

Constructors

Constructor and Description
XmlUtils()

Method Summary

Modifier and Type	Method and Description
static Element	appendCDATAElement(Element parent, String tagName, String value) Appends the CDATA element to the parent element.
static void	appendElement(Element parent, Element child) Appends another element as a child element.
static Element	appendElement(Element parent, String tagName) Appends the child element to the parent element.
static Element	appendElement(Element parent, String tagName, String value) Appends the child element as well as value to the parent element.
static String	childNodeToString(Node node) Converts the Node/Element instance to XML payload.
static Element	createRootElement(String tagName) Creates a root element as well as a new document with specific tag name.
static String	encodeXml(String payload) Encode the XML payload to legality character.
static Element	getChildElement(Element parent, String tagName) Gets the immediately child element from the parent element.
static List<Element>	getChildElements(Element parent, String tagName) Gets the immediately child elements list from the parent element.
static Document	getDocument(File file) Parses the content of the given XML file as an XML document.
static Document	getDocument(InputStream in) Parses the content of the given stream as an XML document.
static Element	getElement(Element parent, String tagName) Gets the immediately descendant element from the parent element.
static List<Element>	getElements(Element parent, String tagName) Gets the descendant elements list from the parent element.
static String	getElementValue(Element element) Gets the text value of current element.
static String	getElementValue(Element parent, String tagName) Gets the value of the child element by tag name under the given parent element.
static Element	getRootElementFromFile(File file) Gets the root element from given XML file.
static Element	getRootElementFromStream(InputStream in) Gets the root element from input stream.
static Element	getRootElementFromString(String payload) Gets the root element from the given XML payload.
static Document	newDocument() Creates a new document instance.
static String	nodeToString(Node node) Converts the Node/Document/Element instance to XML payload.
static void	saveToXml(Node doc, File file) Saves the node/document/element as XML file.
static void	setNamespace(Element element, String namespace, String schemaLocation) Sets the namespace to specific element.
static void	validateXml(Node doc, File schemaFile) Validates the element tree context via given XML schema file.
static void	validateXml(Node doc, InputStream schemaStream) Validates the element tree context via given XML schema file.
static String	xmlToHtml(String payload, File xsltFile) Transforms the XML content to XHTML/HTML format string with the XSL.
static String	xmlToString(File file) Converts the an XML file to XML payload.
static String	xmlToString(InputStream in) Converts the an XML file input stream to XML payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlUtils

public XmlUtils()

Method Detail

newDocument

public static Document newDocument()
                            throws AlipayApiException

Creates a new document instance.

Returns:

a new document instance

Throws:

AlipayApiException - the alipay api exception

getDocument

public static Document getDocument(File file)
                            throws AlipayApiException

Parses the content of the given XML file as an XML document.

Parameters:

file - the XML file instance

Returns:

the document instance representing the entire XML document

Throws:

AlipayApiException - the alipay api exception

getDocument

public static Document getDocument(InputStream in)
                            throws AlipayApiException

Parses the content of the given stream as an XML document.

Parameters:

in - the XML file input stream

Returns:

the document instance representing the entire XML document

Throws:

AlipayApiException - the alipay api exception

createRootElement

public static Element createRootElement(String tagName)
                                 throws AlipayApiException

Creates a root element as well as a new document with specific tag name.

Parameters:

tagName - the name of the root element

Returns:

a new element instance

Throws:

AlipayApiException - the alipay api exception

getRootElementFromStream

public static Element getRootElementFromStream(InputStream in)
                                        throws AlipayApiException

Gets the root element from input stream.

Parameters:

in - the XML file input stream

Returns:

the root element of parsed document

Throws:

AlipayApiException - the alipay api exception

getRootElementFromFile

public static Element getRootElementFromFile(File file)
                                      throws AlipayApiException

Gets the root element from given XML file.

Parameters:

file - the file

Returns:

the root element of parsed document

Throws:

AlipayApiException - the alipay api exception

getRootElementFromString

public static Element getRootElementFromString(String payload)
                                        throws AlipayApiException

Gets the root element from the given XML payload.

Parameters:

payload - the XML payload representing the XML file.

Returns:

the root element of parsed document

Throws:

AlipayApiException - the alipay api exception

getElements

public static List<Element> getElements(Element parent,
                                        String tagName)

Gets the descendant elements list from the parent element.

Parameters:

parent - the parent element in the element tree

tagName - the specified tag name

Returns:

the NOT NULL descendant elements list

getElement

public static Element getElement(Element parent,
                                 String tagName)

Gets the immediately descendant element from the parent element.

Parameters:

parent - the parent element in the element tree

tagName - the specified tag name.

Returns:

immediately descendant element of parent element, NULL otherwise.

getChildElements

public static List<Element> getChildElements(Element parent,
                                             String tagName)

Gets the immediately child elements list from the parent element.

Parameters:

parent - the parent element in the element tree

tagName - the specified tag name

Returns:

the NOT NULL immediately child elements list

getChildElement

public static Element getChildElement(Element parent,
                                      String tagName)

Gets the immediately child element from the parent element.

Parameters:

parent - the parent element in the element tree

tagName - the specified tag name

Returns:

immediately child element of parent element, NULL otherwise

getElementValue

public static String getElementValue(Element parent,
                                     String tagName)

Gets the value of the child element by tag name under the given parent element. If there is more than one child element, return the value of the first one.

Parameters:

parent - the parent element

tagName - the tag name of the child element

Returns:

value of the first child element, NULL if tag not exists

getElementValue

public static String getElementValue(Element element)

Gets the text value of current element.

Parameters:

element - the element

Returns:

text value of the element, NULL if element not exists

appendElement

public static Element appendElement(Element parent,
                                    String tagName)

Appends the child element to the parent element.

Parameters:

parent - the parent element

tagName - the child element name

Returns:

the child element added to the parent element

appendElement

public static Element appendElement(Element parent,
                                    String tagName,
                                    String value)

Appends the child element as well as value to the parent element.

Parameters:

parent - the parent element

tagName - the child element name

value - the child element value

Returns:

the child element added to the parent element

appendElement

public static void appendElement(Element parent,
                                 Element child)

Appends another element as a child element.

Parameters:

parent - the parent element

child - the child element to append

appendCDATAElement

public static Element appendCDATAElement(Element parent,
                                         String tagName,
                                         String value)

Appends the CDATA element to the parent element.

Parameters:

parent - the parent element

tagName - the CDATA element name

value - the CDATA element value

Returns:

the CDATA element added to the parent element

childNodeToString

public static String childNodeToString(Node node)
                                throws AlipayApiException

Converts the Node/Element instance to XML payload.

Parameters:

node - the node/element instance to convert

Returns:

the XML payload representing the node/element

Throws:

AlipayApiException - the alipay api exception

nodeToString

public static String nodeToString(Node node)
                           throws AlipayApiException

Converts the Node/Document/Element instance to XML payload.

Parameters:

node - the node/document/element instance to convert

Returns:

the XML payload representing the node/document/element

Throws:

AlipayApiException - the alipay api exception

xmlToString

public static String xmlToString(File file)
                          throws AlipayApiException

Converts the an XML file to XML payload.

Parameters:

file - the XML file instance

Returns:

the XML payload representing the XML file

Throws:

AlipayApiException - the alipay api exception

xmlToString

public static String xmlToString(InputStream in)
                          throws AlipayApiException

Converts the an XML file input stream to XML payload.

Parameters:

in - the XML file input stream

Returns:

the payload represents the XML file

Throws:

AlipayApiException - the alipay api exception

saveToXml

public static void saveToXml(Node doc,
                             File file)
                      throws AlipayApiException

Saves the node/document/element as XML file.

Parameters:

doc - the XML node/document/element to save

file - the XML file to save

Throws:

AlipayApiException - the alipay api exception

validateXml

public static void validateXml(Node doc,
                               File schemaFile)
                        throws AlipayApiException

Validates the element tree context via given XML schema file.

Parameters:

doc - the XML document to validate

schemaFile - the XML schema file instance

Throws:

AlipayApiException - the alipay api exception

validateXml

public static void validateXml(Node doc,
                               InputStream schemaStream)
                        throws AlipayApiException

Validates the element tree context via given XML schema file.

Parameters:

doc - the XML document to validate

schemaStream - the XML schema file input stream

Throws:

AlipayApiException - the alipay api exception

xmlToHtml

public static String xmlToHtml(String payload,
                               File xsltFile)
                        throws AlipayApiException

Transforms the XML content to XHTML/HTML format string with the XSL.

Parameters:

payload - the XML payload to convert

xsltFile - the XML stylesheet file

Returns:

the transformed XHTML/HTML format string

Throws:

AlipayApiException - the alipay api exception

setNamespace

public static void setNamespace(Element element,
                                String namespace,
                                String schemaLocation)

Sets the namespace to specific element.

Parameters:

element - the element to set

namespace - the namespace to set

schemaLocation - the XML schema file location URI

encodeXml

public static String encodeXml(String payload)
                        throws AlipayApiException

Encode the XML payload to legality character.

Parameters:

payload - the XML payload to encode

Returns:

the encoded XML payload

Throws:

AlipayApiException - the alipay api exception