Class XmlUtils
- java.lang.Object
-
- org.astrogrid.samp.xmlrpc.internal.XmlUtils
-
public class XmlUtils extends java.lang.Object
Utilities for XML manipulations required by SAMP/XML-RPC.- Since:
- 26 Aug 2008
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Modifier Constructor Description private
XmlUtils()
Private constructor prevents instantiation.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description (package private) static javax.xml.parsers.DocumentBuilder
createDocumentBuilder()
Returns a new DocumentBuilder with default characteristics.static org.w3c.dom.Element
getChild(org.w3c.dom.Node parent)
Returns the single element child of a DOM node.static org.w3c.dom.Element
getChild(org.w3c.dom.Node parent, java.lang.String tagName)
Returns the single child element of a DOM node, which has a given known name.static org.w3c.dom.Element[]
getChildren(org.w3c.dom.Node parent)
Returns an array of all the Element children of a DOM node.static java.lang.String
getTextContent(org.w3c.dom.Element el)
Returns the text content of an element as a string.static java.lang.Object
parseSampValue(org.w3c.dom.Element valueEl)
Returns the content of a DOM element representing avalue
element of an XML-RPC document.
-
-
-
Method Detail
-
getChildren
public static org.w3c.dom.Element[] getChildren(org.w3c.dom.Node parent)
Returns an array of all the Element children of a DOM node.- Parameters:
parent
- parent node- Returns:
- children array
-
getChild
public static org.w3c.dom.Element getChild(org.w3c.dom.Node parent) throws XmlRpcFormatException
Returns the single element child of a DOM node.- Parameters:
parent
- parent node- Returns:
- sole child element
- Throws:
XmlRpcFormatException
- if there is not exactly one child per element
-
getChild
public static org.w3c.dom.Element getChild(org.w3c.dom.Node parent, java.lang.String tagName) throws XmlRpcFormatException
Returns the single child element of a DOM node, which has a given known name.- Parameters:
parent
- parent nodetagName
- child node name- Returns:
- sole child element with name
tagName
- Throws:
XmlRpcFormatException
- if there is not exactly one child element or if it does not have nametagName
-
getTextContent
public static java.lang.String getTextContent(org.w3c.dom.Element el) throws XmlRpcFormatException
Returns the text content of an element as a string.- Parameters:
el
- parent node- Returns:
- text content
- Throws:
XmlRpcFormatException
- if content is not just text
-
parseSampValue
public static java.lang.Object parseSampValue(org.w3c.dom.Element valueEl) throws XmlRpcFormatException
Returns the content of a DOM element representing avalue
element of an XML-RPC document. Note that some content which would be legal in XML-RPC, but is not legal in SAMP, may result in an exception.- Parameters:
valueEl
- value element- Returns:
- SAMP-friendly object (string, list or map)
- Throws:
XmlRpcFormatException
-
createDocumentBuilder
static javax.xml.parsers.DocumentBuilder createDocumentBuilder() throws javax.xml.parsers.ParserConfigurationException
Returns a new DocumentBuilder with default characteristics.- Returns:
- new document builder instance
- Throws:
javax.xml.parsers.ParserConfigurationException
-
-