Package net.jodah.xsylum

Class XmlSearchable<T>

java.lang.Object

net.jodah.xsylum.XmlSearchable<T>

Type Parameters:

T - source type

Direct Known Subclasses:

XmlDocument, XmlElement

public abstract class XmlSearchable<T>
extends Object

An XPath searchable XML object.

Field Summary

Fields

Modifier and Type	Field	Description
protected T	source

Method Summary

Modifier and Type	Method	Description
XmlElement	find(String expression)	Returns the first element matching the expression, else null if none can be found.
List<XmlElement>	findAll(String expression)	Returns all elements that match the expression, else empty list if none can be found.
abstract XmlElement	get(String tagName)	Returns the first child element that matches the tagName, else null.
abstract List<XmlElement>	getAll(String tagName)	Returns all child elements that match the tagName else empty List.
String	value(String expression)	Finds the value for the XPath expression.
boolean	valueAsBoolean(String expression)	Finds the value for the XPath expression as a boolean.
double	valueAsDouble(String expression)	Finds the value for the XPath expression as a double.
<V extends Enum<V>> V	valueAsEnum(String expression, Class<V> targetEnum)	Finds the value for the XPath expression as an Enum of type V.
int	valueAsInt(String expression)	Finds the value for the XPath expression as an integer.
long	valueAsLong(String expression)	Finds the value for the XPath expression as a long.
List<String>	values(String expression)	Finds the values for the XPath expression.
List<Boolean>	valuesAsBoolean(String expression)	Finds the values for the XPath expression as booleans.
List<Double>	valuesAsDouble(String expression)	Finds the values for the XPath expression as doubles.
<V extends Enum<V>> List<V>	valuesAsEnum(String expression, Class<V> targetEnum)	Finds the values for the XPath expression as Enums of type V.
List<Integer>	valuesAsInt(String expression)	Finds the values for the XPath expression as integers.
List<Long>	valuesAsLong(String expression)	Finds the values for the XPath expression ending in text() as longs.

Methods inherited from class java.lang.Object

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

Field Detail

source

protected final T source

Method Detail

find

public XmlElement find(String expression)
                throws XPathExpressionException

Returns the first element matching the expression, else null if none can be found.

Throws:

XPathExpressionException - if the expression is invalid

findAll

public List<XmlElement> findAll(String expression)
                         throws XPathExpressionException

Returns all elements that match the expression, else empty list if none can be found.

Throws:

XPathExpressionException - if the expression is invalid

get

public abstract XmlElement get(String tagName)

Returns the first child element that matches the tagName, else null.

getAll

public abstract List<XmlElement> getAll(String tagName)

Returns all child elements that match the tagName else empty List.

value

public String value(String expression)
             throws XPathExpressionException

Finds the value for the XPath expression.

Throws:

XPathExpressionException - if the expression is invalid

valueAsBoolean

public boolean valueAsBoolean(String expression)
                       throws XPathExpressionException

Finds the value for the XPath expression as a boolean. Returns true for "true", "1", "yes", "y" ignoring case, else returns false.

Throws:

XPathExpressionException - if the expression is invalid

valueAsDouble

public double valueAsDouble(String expression)
                     throws XPathExpressionException

Finds the value for the XPath expression as a double.

Throws:

XPathExpressionException - if the expression is invalid

NumberFormatException - if the value for the expression is not a valid double

valueAsEnum

public <V extends Enum<V>> V valueAsEnum(String expression,
                                         Class<V> targetEnum)
                                  throws XPathExpressionException

Finds the value for the XPath expression as an Enum of type V. Returns null if value cannot be parsed to an Enum of type V.

Type Parameters:

V - enum type

Throws:

XPathExpressionException - if the expression is invalid

valueAsInt

public int valueAsInt(String expression)
               throws XPathExpressionException

Finds the value for the XPath expression as an integer.

Throws:

XPathExpressionException - if the expression is invalid

NumberFormatException - if the value for the expression is not a valid int

valueAsLong

public long valueAsLong(String expression)
                 throws XPathExpressionException

Finds the value for the XPath expression as a long.

Throws:

XPathExpressionException - if the expression is invalid

NumberFormatException - if the value for the expression is not a valid long

values

public List<String> values(String expression)
                    throws XPathExpressionException

Finds the values for the XPath expression.

Throws:

XPathExpressionException - if the expression is invalid

valuesAsBoolean

public List<Boolean> valuesAsBoolean(String expression)
                              throws XPathExpressionException

Finds the values for the XPath expression as booleans. Returns true for "true", "1", "yes", "y" ignoring case, else returns false.

Throws:

XPathExpressionException - if the expression is invalid

valuesAsDouble

public List<Double> valuesAsDouble(String expression)
                            throws XPathExpressionException

Finds the values for the XPath expression as doubles.

Throws:

XPathExpressionException - if the expression is invalid

NumberFormatException - if the values for the expression are not valid doubles

valuesAsEnum

public <V extends Enum<V>> List<V> valuesAsEnum(String expression,
                                                Class<V> targetEnum)
                                         throws XPathExpressionException

Finds the values for the XPath expression as Enums of type V. Returns null for values that cannot be parsed to an Enum of type V.

Type Parameters:

V - enum type

Throws:

XPathExpressionException - if the expression is invalid

valuesAsInt

public List<Integer> valuesAsInt(String expression)
                          throws XPathExpressionException

Finds the values for the XPath expression as integers.

Throws:

XPathExpressionException - if the expression is invalid

NumberFormatException - if the values for the expression are not valid ints

valuesAsLong

public List<Long> valuesAsLong(String expression)
                        throws XPathExpressionException

Finds the values for the XPath expression ending in text() as longs.

Throws:

XPathExpressionException - if the expression is invalid

NumberFormatException - if the values for the expression are not valid longs