com.amazonaws.util

Class XpathUtils

java.lang.Object

com.amazonaws.util.XpathUtils

public class XpathUtils
extends java.lang.Object

Utility methods for extracting data from XML documents using Xpath expressions.

Constructor Summary

Constructors

Constructor and Description
XpathUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.Boolean	asBoolean(java.lang.String expression, org.w3c.dom.Node node) Evaluates the specified XPath expression and returns the result as a Boolean.
static java.lang.Byte	asByte(java.lang.String expression, org.w3c.dom.Node node) Evaluates the specified XPath expression and returns the result as a Byte.
static java.nio.ByteBuffer	asByteBuffer(java.lang.String expression, org.w3c.dom.Node node) Evaluates the specified xpath expression, base64 decodes the data and returns the result as a ByteBuffer.
static java.util.Date	asDate(java.lang.String expression, org.w3c.dom.Node node) Evaluates the specified XPath expression and returns the result as a Date.
static java.lang.Double	asDouble(java.lang.String expression, org.w3c.dom.Node node) Evaluates the specified XPath expression and returns the results as a Double.
static java.lang.Float	asFloat(java.lang.String expression, org.w3c.dom.Node node) Evaluates the specified XPath expression and returns the result as a Float.
static java.lang.Integer	asInteger(java.lang.String expression, org.w3c.dom.Node node) Evaluates the specified XPath expression and returns the result as an Integer.
static java.lang.Long	asLong(java.lang.String expression, org.w3c.dom.Node node) Evaluates the specified XPath expression and returns the result as a Long.
static org.w3c.dom.Node	asNode(java.lang.String nodeName, org.w3c.dom.Node node)
static java.lang.String	asString(java.lang.String expression, org.w3c.dom.Node node) Evaluates the specified XPath expression and returns the result as a string.
static org.w3c.dom.Document	documentFrom(java.io.InputStream is) InputStream to Document.
static org.w3c.dom.Document	documentFrom(java.lang.String xml) Xml string to Document.
static org.w3c.dom.Document	documentFrom(java.net.URL url) URL to Document,
static boolean	isEmpty(org.w3c.dom.Node node) Returns true if the specified node is null or has no children.
static int	nodeLength(org.w3c.dom.NodeList list) Returns the length of the specified node list.
static javax.xml.xpath.XPath	xpath()

Methods inherited from class java.lang.Object

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

Constructor Detail

XpathUtils

public XpathUtils()

Method Detail

documentFrom

public static org.w3c.dom.Document documentFrom(java.io.InputStream is)
                                         throws org.xml.sax.SAXException,
                                                java.io.IOException,
                                                javax.xml.parsers.ParserConfigurationException

InputStream to Document.

Parameters:

is - the input stream.

Returns:

the Document.

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

documentFrom

public static org.w3c.dom.Document documentFrom(java.lang.String xml)
                                         throws org.xml.sax.SAXException,
                                                java.io.IOException,
                                                javax.xml.parsers.ParserConfigurationException

Xml string to Document.

Parameters:

xml - the xml string.

Returns:

the Document.

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

documentFrom

public static org.w3c.dom.Document documentFrom(java.net.URL url)
                                         throws org.xml.sax.SAXException,
                                                java.io.IOException,
                                                javax.xml.parsers.ParserConfigurationException

URL to Document,

Parameters:

url - the URL.

Returns:

the Document.

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

asDouble

public static java.lang.Double asDouble(java.lang.String expression,
                                        org.w3c.dom.Node node)
                                 throws javax.xml.xpath.XPathExpressionException

Evaluates the specified XPath expression and returns the results as a Double.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Double result.

Throws:

javax.xml.xpath.XPathExpressionException - If there was a problem processing the specified XPath expression.

asString

public static java.lang.String asString(java.lang.String expression,
                                        org.w3c.dom.Node node)
                                 throws javax.xml.xpath.XPathExpressionException

Evaluates the specified XPath expression and returns the result as a string.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The string result.

Throws:

javax.xml.xpath.XPathExpressionException - If there was a problem processing the specified XPath expression.

asInteger

public static java.lang.Integer asInteger(java.lang.String expression,
                                          org.w3c.dom.Node node)
                                   throws javax.xml.xpath.XPathExpressionException

Evaluates the specified XPath expression and returns the result as an Integer.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Integer result.

Throws:

javax.xml.xpath.XPathExpressionException - If there was a problem processing the specified XPath expression.

asBoolean

public static java.lang.Boolean asBoolean(java.lang.String expression,
                                          org.w3c.dom.Node node)
                                   throws javax.xml.xpath.XPathExpressionException

Evaluates the specified XPath expression and returns the result as a Boolean.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Boolean result.

Throws:

javax.xml.xpath.XPathExpressionException - If there was a problem processing the specified XPath expression.

asFloat

public static java.lang.Float asFloat(java.lang.String expression,
                                      org.w3c.dom.Node node)
                               throws javax.xml.xpath.XPathExpressionException

Evaluates the specified XPath expression and returns the result as a Float.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Float result.

Throws:

javax.xml.xpath.XPathExpressionException - If there was a problem processing the specified XPath expression.

asLong

public static java.lang.Long asLong(java.lang.String expression,
                                    org.w3c.dom.Node node)
                             throws javax.xml.xpath.XPathExpressionException

Evaluates the specified XPath expression and returns the result as a Long.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Long result.

Throws:

javax.xml.xpath.XPathExpressionException - If there was a problem processing the specified XPath expression.

asByte

public static java.lang.Byte asByte(java.lang.String expression,
                                    org.w3c.dom.Node node)
                             throws javax.xml.xpath.XPathExpressionException

Evaluates the specified XPath expression and returns the result as a Byte.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Byte result.

Throws:

javax.xml.xpath.XPathExpressionException - If there was a problem processing the specified XPath expression.

asDate

public static java.util.Date asDate(java.lang.String expression,
                                    org.w3c.dom.Node node)
                             throws javax.xml.xpath.XPathExpressionException

Evaluates the specified XPath expression and returns the result as a Date. Assumes that the node's text is formatted as an ISO 8601 date, as specified by xs:dateTime.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Date result.

Throws:

javax.xml.xpath.XPathExpressionException - If there was a problem processing the specified XPath expression.

asByteBuffer

public static java.nio.ByteBuffer asByteBuffer(java.lang.String expression,
                                               org.w3c.dom.Node node)
                                        throws javax.xml.xpath.XPathExpressionException

Evaluates the specified xpath expression, base64 decodes the data and returns the result as a ByteBuffer.

Parameters:

expression - The Xpath expression to evaluate.

node - The node on which to evaluate the expression.

Returns:

A ByteBuffer of base64 decoded data from the result of evaluating the specified Xpath expression.

Throws:

javax.xml.xpath.XPathExpressionException - If there are any problems evaluating the Xpath expression.

isEmpty

public static boolean isEmpty(org.w3c.dom.Node node)

Returns true if the specified node is null or has no children.

Parameters:

node - The node to test.

Returns:

True if the specified node is null or has no children.

nodeLength

public static int nodeLength(org.w3c.dom.NodeList list)

Returns the length of the specified node list.

Parameters:

list - The node list to measure.

Returns:

The length of the specified node list.

asNode

public static org.w3c.dom.Node asNode(java.lang.String nodeName,
                                      org.w3c.dom.Node node)
                               throws javax.xml.xpath.XPathExpressionException

Parameters:

nodeName - the node name.

node - the node.

Returns:

the Node.

Throws:

javax.xml.xpath.XPathExpressionException

xpath

public static javax.xml.xpath.XPath xpath()

Returns:

a new instance of XPath, which is not thread safe and not reentrant.