com.ibm.cloud.objectstorage.util

Class XpathUtils

java.lang.Object

com.ibm.cloud.objectstorage.util.XpathUtils

public class XpathUtils
extends 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 Boolean	asBoolean(String expression, Node node) Evaluates the specified XPath expression and returns the result as a Boolean.
static Boolean	asBoolean(String expression, Node node, XPath xpath) Same as XpathUtils.asBoolean(String, Node) but allows an xpath to be passed in explicitly for reuse.
static Byte	asByte(String expression, Node node) Evaluates the specified XPath expression and returns the result as a Byte.
static Byte	asByte(String expression, Node node, XPath xpath) Same as XpathUtils.asByte(String, Node) but allows an xpath to be passed in explicitly for reuse.
static ByteBuffer	asByteBuffer(String expression, Node node) Evaluates the specified xpath expression, base64 decodes the data and returns the result as a ByteBuffer.
static ByteBuffer	asByteBuffer(String expression, Node node, XPath xpath) Same as XpathUtils.asByteBuffer(String, Node) but allows an xpath to be passed in explicitly for reuse.
static Date	asDate(String expression, Node node) Evaluates the specified XPath expression and returns the result as a Date.
static Date	asDate(String expression, Node node, XPath xpath) Same as XpathUtils.asDate(String, Node) but allows an xpath to be passed in explicitly for reuse.
static Double	asDouble(String expression, Node node) Evaluates the specified XPath expression and returns the results as a Double.
static Double	asDouble(String expression, Node node, XPath xpath) Same as XpathUtils.asDouble(String, Node) but allows an xpath to be passed in explicitly for reuse.
static Float	asFloat(String expression, Node node) Evaluates the specified XPath expression and returns the result as a Float.
static Float	asFloat(String expression, Node node, XPath xpath) Same as XpathUtils.asFloat(String, Node) but allows an xpath to be passed in explicitly for reuse.
static Integer	asInteger(String expression, Node node) Evaluates the specified XPath expression and returns the result as an Integer.
static Integer	asInteger(String expression, Node node, XPath xpath) Same as XpathUtils.asInteger(String, Node) but allows an xpath to be passed in explicitly for reuse.
static Long	asLong(String expression, Node node) Evaluates the specified XPath expression and returns the result as a Long.
static Long	asLong(String expression, Node node, XPath xpath) Same as XpathUtils.asLong(String, Node) but allows an xpath to be passed in explicitly for reuse.
static Node	asNode(String nodeName, Node node) Evaluates the specified XPath expression and returns the result as a Node.
static Node	asNode(String nodeName, Node node, XPath xpath) Same as XpathUtils.asNode(String, Node) but allows an xpath to be passed in explicitly for reuse.
static String	asString(String expression, Node node) Evaluates the specified XPath expression and returns the result as a string.
static String	asString(String expression, Node node, XPath xpath) Same as XpathUtils.asString(String, Node) but allows an xpath to be passed in explicitly for reuse.
static Document	documentFrom(InputStream is) This method closes the given input stream upon completion.
static Document	documentFrom(String xml)
static Document	documentFrom(URL url)
static boolean	isEmpty(Node node) Returns true if the specified node is null or has no children.
static int	nodeLength(NodeList list) Returns the length of the specified node list.
static XPath	xpath() Returns a new instance of XPath, which is not thread safe and not reentrant.

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

xpath

public static XPath xpath()

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

documentFrom

public static Document documentFrom(InputStream is)
                             throws SAXException,
                                    IOException,
                                    ParserConfigurationException

This method closes the given input stream upon completion.

Throws:

SAXException

IOException

ParserConfigurationException

documentFrom

public static Document documentFrom(String xml)
                             throws SAXException,
                                    IOException,
                                    ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException

documentFrom

public static Document documentFrom(URL url)
                             throws SAXException,
                                    IOException,
                                    ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException

asDouble

public static Double asDouble(String expression,
                              Node node)
                       throws XPathExpressionException

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

This method can be expensive as a new xpath is instantiated per invocation. Consider passing in the xpath explicitly via { XpathUtils.asDouble(String, Node, XPath) instead. Note XPath is not thread-safe and not reentrant.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Double result.

Throws:

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

asDouble

public static Double asDouble(String expression,
                              Node node,
                              XPath xpath)
                       throws XPathExpressionException

Same as XpathUtils.asDouble(String, Node) but allows an xpath to be passed in explicitly for reuse.

Throws:

XPathExpressionException

asString

public static String asString(String expression,
                              Node node)
                       throws XPathExpressionException

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

This method can be expensive as a new xpath is instantiated per invocation. Consider passing in the xpath explicitly via { XpathUtils.asDouble(String, Node, XPath) instead. Note XPath is not thread-safe and not reentrant.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The string result.

Throws:

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

asString

public static String asString(String expression,
                              Node node,
                              XPath xpath)
                       throws XPathExpressionException

Same as XpathUtils.asString(String, Node) but allows an xpath to be passed in explicitly for reuse.

Throws:

XPathExpressionException

asInteger

public static Integer asInteger(String expression,
                                Node node)
                         throws XPathExpressionException

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

This method can be expensive as a new xpath is instantiated per invocation. Consider passing in the xpath explicitly via { XpathUtils.asDouble(String, Node, XPath) instead. Note XPath is not thread-safe and not reentrant.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Integer result.

Throws:

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

asInteger

public static Integer asInteger(String expression,
                                Node node,
                                XPath xpath)
                         throws XPathExpressionException

Same as XpathUtils.asInteger(String, Node) but allows an xpath to be passed in explicitly for reuse.

Throws:

XPathExpressionException

asBoolean

public static Boolean asBoolean(String expression,
                                Node node)
                         throws XPathExpressionException

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

This method can be expensive as a new xpath is instantiated per invocation. Consider passing in the xpath explicitly via { XpathUtils.asDouble(String, Node, XPath) instead. Note XPath is not thread-safe and not reentrant.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Boolean result.

Throws:

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

asBoolean

public static Boolean asBoolean(String expression,
                                Node node,
                                XPath xpath)
                         throws XPathExpressionException

Same as XpathUtils.asBoolean(String, Node) but allows an xpath to be passed in explicitly for reuse.

Throws:

XPathExpressionException

asFloat

public static Float asFloat(String expression,
                            Node node)
                     throws XPathExpressionException

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

This method can be expensive as a new xpath is instantiated per invocation. Consider passing in the xpath explicitly via { XpathUtils.asDouble(String, Node, XPath) instead. Note XPath is not thread-safe and not reentrant.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Float result.

Throws:

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

asFloat

public static Float asFloat(String expression,
                            Node node,
                            XPath xpath)
                     throws XPathExpressionException

Same as XpathUtils.asFloat(String, Node) but allows an xpath to be passed in explicitly for reuse.

Throws:

XPathExpressionException

asLong

public static Long asLong(String expression,
                          Node node)
                   throws XPathExpressionException

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

This method can be expensive as a new xpath is instantiated per invocation. Consider passing in the xpath explicitly via { XpathUtils.asDouble(String, Node, XPath) instead. Note XPath is not thread-safe and not reentrant.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Long result.

Throws:

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

asLong

public static Long asLong(String expression,
                          Node node,
                          XPath xpath)
                   throws XPathExpressionException

Same as XpathUtils.asLong(String, Node) but allows an xpath to be passed in explicitly for reuse.

Throws:

XPathExpressionException

asByte

public static Byte asByte(String expression,
                          Node node)
                   throws XPathExpressionException

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

This method can be expensive as a new xpath is instantiated per invocation. Consider passing in the xpath explicitly via { XpathUtils.asDouble(String, Node, XPath) instead. Note XPath is not thread-safe and not reentrant.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Byte result.

Throws:

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

asByte

public static Byte asByte(String expression,
                          Node node,
                          XPath xpath)
                   throws XPathExpressionException

Same as XpathUtils.asByte(String, Node) but allows an xpath to be passed in explicitly for reuse.

Throws:

XPathExpressionException

asDate

public static Date asDate(String expression,
                          Node node)
                   throws 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.

This method can be expensive as a new xpath is instantiated per invocation. Consider passing in the xpath explicitly via { XpathUtils.asDouble(String, Node, XPath) instead. Note XPath is not thread-safe and not reentrant.

Parameters:

expression - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Date result.

Throws:

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

asDate

public static Date asDate(String expression,
                          Node node,
                          XPath xpath)
                   throws XPathExpressionException

Same as XpathUtils.asDate(String, Node) but allows an xpath to be passed in explicitly for reuse.

Throws:

XPathExpressionException

asByteBuffer

public static ByteBuffer asByteBuffer(String expression,
                                      Node node)
                               throws XPathExpressionException

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

This method can be expensive as a new xpath is instantiated per invocation. Consider passing in the xpath explicitly via { XpathUtils.asDouble(String, Node, XPath) instead. Note XPath is not thread-safe and not reentrant.

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:

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

asByteBuffer

public static ByteBuffer asByteBuffer(String expression,
                                      Node node,
                                      XPath xpath)
                               throws XPathExpressionException

Same as XpathUtils.asByteBuffer(String, Node) but allows an xpath to be passed in explicitly for reuse.

Throws:

XPathExpressionException

isEmpty

public static boolean isEmpty(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.

asNode

public static Node asNode(String nodeName,
                          Node node)
                   throws XPathExpressionException

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

Parameters:

nodeName - The XPath expression to evaluate.

node - The node to run the expression on.

Returns:

The Node result.

Throws:

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

asNode

public static Node asNode(String nodeName,
                          Node node,
                          XPath xpath)
                   throws XPathExpressionException

Same as XpathUtils.asNode(String, Node) but allows an xpath to be passed in explicitly for reuse.

Throws:

XPathExpressionException

nodeLength

public static int nodeLength(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.