XmlUtils (open_kit Maven Webapp 1.1.12 API)

java.lang.Object
- com.alipay.api.internal.util.XmlUtils

```
public final class XmlUtils
extends java.lang.Object
```
Encapsulating XML common operations.

从以下版本开始:

1.0, Jun 12, 2007

作者:

carver

构造器概要

构造器
构造器和说明

XmlUtils()

构造器
构造器和说明
`XmlUtils()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static org.w3c.dom.Element`	`appendCDATAElement(org.w3c.dom.Element parent, java.lang.String tagName, java.lang.String value)` Appends the CDATA element to the parent element.
`static void`	`appendElement(org.w3c.dom.Element parent, org.w3c.dom.Element child)` Appends another element as a child element.
`static org.w3c.dom.Element`	`appendElement(org.w3c.dom.Element parent, java.lang.String tagName)` Appends the child element to the parent element.
`static org.w3c.dom.Element`	`appendElement(org.w3c.dom.Element parent, java.lang.String tagName, java.lang.String value)` Appends the child element as well as value to the parent element.
`static java.lang.String`	`childNodeToString(org.w3c.dom.Node node)` Converts the Node/Element instance to XML payload.
`static org.w3c.dom.Element`	`createRootElement(java.lang.String tagName)` Creates a root element as well as a new document with specific tag name.
`static java.lang.String`	`encodeXml(java.lang.String payload)` Encode the XML payload to legality character.
`static org.w3c.dom.Element`	`getChildElement(org.w3c.dom.Element parent, java.lang.String tagName)` Gets the immediately child element from the parent element.
`static java.util.List<org.w3c.dom.Element>`	`getChildElements(org.w3c.dom.Element parent, java.lang.String tagName)` Gets the immediately child elements list from the parent element.
`static org.w3c.dom.Document`	`getDocument(java.io.File file)` Parses the content of the given XML file as an XML document.
`static org.w3c.dom.Document`	`getDocument(java.io.InputStream in)` Parses the content of the given stream as an XML document.
`static org.w3c.dom.Element`	`getElement(org.w3c.dom.Element parent, java.lang.String tagName)` Gets the immediately descendant element from the parent element.
`static java.util.List<org.w3c.dom.Element>`	`getElements(org.w3c.dom.Element parent, java.lang.String tagName)` Gets the descendant elements list from the parent element.
`static java.lang.String`	`getElementValue(org.w3c.dom.Element element)` Gets the text value of current element.
`static java.lang.String`	`getElementValue(org.w3c.dom.Element parent, java.lang.String tagName)` Gets the value of the child element by tag name under the given parent element.
`static org.w3c.dom.Element`	`getRootElementFromFile(java.io.File file)` Gets the root element from given XML file.
`static org.w3c.dom.Element`	`getRootElementFromStream(java.io.InputStream in)` Gets the root element from input stream.
`static org.w3c.dom.Element`	`getRootElementFromString(java.lang.String payload)` Gets the root element from the given XML payload.
`static org.w3c.dom.Document`	`newDocument()` Creates a new document instance.
`static java.lang.String`	`nodeToString(org.w3c.dom.Node node)` Converts the Node/Document/Element instance to XML payload.
`static void`	`saveToXml(org.w3c.dom.Node doc, java.io.File file)` Saves the node/document/element as XML file.
`static void`	`setNamespace(org.w3c.dom.Element element, java.lang.String namespace, java.lang.String schemaLocation)` Sets the namespace to specific element.
`static void`	`validateXml(org.w3c.dom.Node doc, java.io.File schemaFile)` Validates the element tree context via given XML schema file.
`static void`	`validateXml(org.w3c.dom.Node doc, java.io.InputStream schemaStream)` Validates the element tree context via given XML schema file.
`static java.lang.String`	`xmlToHtml(java.lang.String payload, java.io.File xsltFile)` Transforms the XML content to XHTML/HTML format string with the XSL.
`static java.lang.String`	`xmlToString(java.io.File file)` Converts the an XML file to XML payload.
`static java.lang.String`	`xmlToString(java.io.InputStream in)` Converts the an XML file input stream to XML payload.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - XmlUtils
```
public XmlUtils()
```
- 方法详细资料
  - newDocument
```
public static org.w3c.dom.Document newDocument()
                                        throws AlipayApiException
```
    Creates a new document instance.
    
    返回:
    
    a new document instance
    
    抛出:
    
    AlipayApiException - problem creating a new document
  - getDocument
```
public static org.w3c.dom.Document getDocument(java.io.File file)
                                        throws AlipayApiException
```
    Parses the content of the given XML file as an XML document.
    
    参数:
    
    file - the XML file instance
    
    返回:
    
    the document instance representing the entire XML document
    
    抛出:
    
    AlipayApiException - problem parsing the XML file
  - getDocument
```
public static org.w3c.dom.Document getDocument(java.io.InputStream in)
                                        throws AlipayApiException
```
    Parses the content of the given stream as an XML document.
    
    参数:
    
    in - the XML file input stream
    
    返回:
    
    the document instance representing the entire XML document
    
    抛出:
    
    AlipayApiException - problem parsing the XML input stream
  - createRootElement
```
public static org.w3c.dom.Element createRootElement(java.lang.String tagName)
                                             throws AlipayApiException
```
    Creates a root element as well as a new document with specific tag name.
    
    参数:
    
    tagName - the name of the root element
    
    返回:
    
    a new element instance
    
    抛出:
    
    AlipayApiException - problem generating a new document
  - getRootElementFromStream
```
public static org.w3c.dom.Element getRootElementFromStream(java.io.InputStream in)
                                                    throws AlipayApiException
```
    Gets the root element from input stream.
    
    参数:
    
    in - the XML file input stream
    
    返回:
    
    the root element of parsed document
    
    抛出:
    
    AlipayApiException - problem parsing the XML file input stream
  - getRootElementFromFile
```
public static org.w3c.dom.Element getRootElementFromFile(java.io.File file)
                                                  throws AlipayApiException
```
    Gets the root element from given XML file.
    
    参数:
    
    file - the name of the XML file
    
    返回:
    
    the root element of parsed document
    
    抛出:
    
    AlipayApiException - problem parsing the XML file
  - getRootElementFromString
```
public static org.w3c.dom.Element getRootElementFromString(java.lang.String payload)
                                                    throws AlipayApiException
```
    Gets the root element from the given XML payload.
    
    参数:
    
    payload - the XML payload representing the XML file.
    
    返回:
    
    the root element of parsed document
    
    抛出:
    
    AlipayApiException - problem parsing the XML payload
  - getElements
```
public static java.util.List<org.w3c.dom.Element> getElements(org.w3c.dom.Element parent,
                                                              java.lang.String tagName)
```
    Gets the descendant elements list from the parent element.
    
    参数:
    
    parent - the parent element in the element tree
    
    tagName - the specified tag name
    
    返回:
    
    the NOT NULL descendant elements list
  - getElement
```
public static org.w3c.dom.Element getElement(org.w3c.dom.Element parent,
                                             java.lang.String tagName)
```
    Gets the immediately descendant element from the parent element.
    
    参数:
    
    parent - the parent element in the element tree
    
    tagName - the specified tag name.
    
    返回:
    
    immediately descendant element of parent element, NULL otherwise.
  - getChildElements
```
public static java.util.List<org.w3c.dom.Element> getChildElements(org.w3c.dom.Element parent,
                                                                   java.lang.String tagName)
```
    Gets the immediately child elements list from the parent element.
    
    参数:
    
    parent - the parent element in the element tree
    
    tagName - the specified tag name
    
    返回:
    
    the NOT NULL immediately child elements list
  - getChildElement
```
public static org.w3c.dom.Element getChildElement(org.w3c.dom.Element parent,
                                                  java.lang.String tagName)
```
    Gets the immediately child element from the parent element.
    
    参数:
    
    parent - the parent element in the element tree
    
    tagName - the specified tag name
    
    返回:
    
    immediately child element of parent element, NULL otherwise
  - getElementValue
```
public static java.lang.String getElementValue(org.w3c.dom.Element parent,
                                               java.lang.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.
    
    参数:
    
    parent - the parent element
    
    tagName - the tag name of the child element
    
    返回:
    
    value of the first child element, NULL if tag not exists
  - getElementValue
```
public static java.lang.String getElementValue(org.w3c.dom.Element element)
```
    Gets the text value of current element.
    
    参数:
    
    element - the current element
    
    返回:
    
    text value of the element, NULL if element not exists
  - appendElement
```
public static org.w3c.dom.Element appendElement(org.w3c.dom.Element parent,
                                                java.lang.String tagName)
```
    Appends the child element to the parent element.
    
    参数:
    
    parent - the parent element
    
    tagName - the child element name
    
    返回:
    
    the child element added to the parent element
  - appendElement
```
public static org.w3c.dom.Element appendElement(org.w3c.dom.Element parent,
                                                java.lang.String tagName,
                                                java.lang.String value)
```
    Appends the child element as well as value to the parent element.
    
    参数:
    
    parent - the parent element
    
    tagName - the child element name
    
    value - the child element value
    
    返回:
    
    the child element added to the parent element
  - appendElement
```
public static void appendElement(org.w3c.dom.Element parent,
                                 org.w3c.dom.Element child)
```
    Appends another element as a child element.
    
    参数:
    
    parent - the parent element
    
    child - the child element to append
  - appendCDATAElement
```
public static org.w3c.dom.Element appendCDATAElement(org.w3c.dom.Element parent,
                                                     java.lang.String tagName,
                                                     java.lang.String value)
```
    Appends the CDATA element to the parent element.
    
    参数:
    
    parent - the parent element
    
    tagName - the CDATA element name
    
    value - the CDATA element value
    
    返回:
    
    the CDATA element added to the parent element
  - childNodeToString
```
public static java.lang.String childNodeToString(org.w3c.dom.Node node)
                                          throws AlipayApiException
```
    Converts the Node/Element instance to XML payload.
    
    参数:
    
    node - the node/element instance to convert
    
    返回:
    
    the XML payload representing the node/element
    
    抛出:
    
    AlipayApiException - problem converting XML to string
  - nodeToString
```
public static java.lang.String nodeToString(org.w3c.dom.Node node)
                                     throws AlipayApiException
```
    Converts the Node/Document/Element instance to XML payload.
    
    参数:
    
    node - the node/document/element instance to convert
    
    返回:
    
    the XML payload representing the node/document/element
    
    抛出:
    
    AlipayApiException - problem converting XML to string
  - xmlToString
```
public static java.lang.String xmlToString(java.io.File file)
                                    throws AlipayApiException
```
    Converts the an XML file to XML payload.
    
    参数:
    
    file - the XML file instance
    
    返回:
    
    the XML payload representing the XML file
    
    抛出:
    
    AlipayApiException - problem transforming XML to string
  - xmlToString
```
public static java.lang.String xmlToString(java.io.InputStream in)
                                    throws AlipayApiException
```
    Converts the an XML file input stream to XML payload.
    
    参数:
    
    in - the XML file input stream
    
    返回:
    
    the payload represents the XML file
    
    抛出:
    
    AlipayApiException - problem transforming XML to string
  - saveToXml
```
public static void saveToXml(org.w3c.dom.Node doc,
                             java.io.File file)
                      throws AlipayApiException
```
    Saves the node/document/element as XML file.
    
    参数:
    
    doc - the XML node/document/element to save
    
    file - the XML file to save
    
    抛出:
    
    AlipayApiException - problem persisting XML file
  - validateXml
```
public static void validateXml(org.w3c.dom.Node doc,
                               java.io.File schemaFile)
                        throws AlipayApiException
```
    Validates the element tree context via given XML schema file.
    
    参数:
    
    doc - the XML document to validate
    
    schemaFile - the XML schema file instance
    
    抛出:
    
    AlipayApiException - error occurs if the schema file not exists
  - validateXml
```
public static void validateXml(org.w3c.dom.Node doc,
                               java.io.InputStream schemaStream)
                        throws AlipayApiException
```
    Validates the element tree context via given XML schema file.
    
    参数:
    
    doc - the XML document to validate
    
    schemaStream - the XML schema file input stream
    
    抛出:
    
    AlipayApiException - error occurs if validation fail
  - xmlToHtml
```
public static java.lang.String xmlToHtml(java.lang.String payload,
                                         java.io.File xsltFile)
                                  throws AlipayApiException
```
    Transforms the XML content to XHTML/HTML format string with the XSL.
    
    参数:
    
    payload - the XML payload to convert
    
    xsltFile - the XML stylesheet file
    
    返回:
    
    the transformed XHTML/HTML format string
    
    抛出:
    
    AlipayApiException - problem converting XML to HTML
  - setNamespace
```
public static void setNamespace(org.w3c.dom.Element element,
                                java.lang.String namespace,
                                java.lang.String schemaLocation)
```
    Sets the namespace to specific element.
    
    参数:
    
    element - the element to set
    
    namespace - the namespace to set
    
    schemaLocation - the XML schema file location URI
  - encodeXml
```
public static java.lang.String encodeXml(java.lang.String payload)
                                  throws AlipayApiException
```
    Encode the XML payload to legality character.
    
    参数:
    
    payload - the XML payload to encode
    
    返回:
    
    the encoded XML payload
    
    抛出:
    
    AlipayApiException - problem encoding the XML payload

类 XmlUtils

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

XmlUtils

方法详细资料

newDocument

getDocument

getDocument

createRootElement

getRootElementFromStream

getRootElementFromFile

getRootElementFromString

getElements

getElement

getChildElements

getChildElement

getElementValue

getElementValue

appendElement

appendElement

appendElement

appendCDATAElement

childNodeToString

nodeToString

xmlToString

xmlToString

saveToXml

validateXml

validateXml

xmlToHtml

setNamespace

encodeXml