Package io.jenkins.plugins.xmleditor.core.xpath

Class XPathEngine

java.lang.Object

io.jenkins.plugins.xmleditor.core.xpath.XPathEngine

public final class XPathEngine
extends Object

Evaluates XPath 1.0 expressions on a lossless document and maps selected nodes back to it.

Constructor Summary

Constructors

Constructor	Description
XPathEngine(LDocument doc, XPathOptions options)

Method Summary

Modifier and Type	Method	Description
boolean	evaluateBoolean(String expression)
List<String>	evaluateList(String expression)	String values of all selected nodes (a single element list for non node-set expressions).
double	evaluateNumber(String expression)
Optional<String>	evaluateString(String expression)	String value of the first selected node, or the string result of a non node-set expression.
void	refresh()	Rebuilds the XPath view after the document has been modified, including namespace prefixes it declares.
List<LItem>	selectNodes(String expression)	Nodes selected by expression: elements, attributes, text, CDATA, comments or PIs.
List<String>	warnings()

Methods inherited from class java.lang.Object

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

Constructor Details

XPathEngine

public XPathEngine(LDocument doc,
 XPathOptions options)
            throws XmlEditorException

Throws:

XmlEditorException

Method Details

refresh

public void refresh()
             throws XmlEditorException

Rebuilds the XPath view after the document has been modified, including namespace prefixes it declares.

Throws:

XmlEditorException

warnings

public List<String> warnings()

selectNodes

public List<LItem> selectNodes(String expression)
                        throws XmlEditorException

Nodes selected by expression: elements, attributes, text, CDATA, comments or PIs.

Throws:

XmlEditorException

evaluateString

public Optional<String> evaluateString(String expression)
                                throws XmlEditorException

String value of the first selected node, or the string result of a non node-set expression.

Returns:

empty when the expression selects no node

Throws:

XmlEditorException

evaluateList

public List<String> evaluateList(String expression)
                          throws XmlEditorException

String values of all selected nodes (a single element list for non node-set expressions).

Throws:

XmlEditorException

evaluateNumber

public double evaluateNumber(String expression)
                      throws XmlEditorException

Throws:

XmlEditorException

evaluateBoolean

public boolean evaluateBoolean(String expression)
                        throws XmlEditorException

Throws:

XmlEditorException