XPath
interface XPath
javax.xml.xpath.XPath |
XPath
provides access to the XPath evaluation environment and expressions.
Evaluation of XPath Expressions. | |
---|---|
context | If a request is made to evaluate the expression in the absence of a context item, an empty document node will be used for the context. For the purposes of evaluating XPath expressions, a DocumentFragment is treated like a Document node. |
variables | If the expression contains a variable reference, its value will be found through the XPathVariableResolver set with setXPathVariableResolver(javax.xml.xpath.XPathVariableResolver) . An XPathExpressionException is raised if the variable resolver is undefined or the resolver returns null for the variable. The value of a variable must be immutable through the course of any single evaluation.
|
functions | If the expression contains a function reference, the function will be found through the XPathFunctionResolver set with setXPathFunctionResolver(javax.xml.xpath.XPathFunctionResolver) . An XPathExpressionException is raised if the function resolver is undefined or the function resolver returns null for the function.
|
QNames | QNames in the expression are resolved against the XPath namespace context set with setNamespaceContext(javax.xml.namespace.NamespaceContext) . |
result | This result of evaluating an expression is converted to an instance of the desired return type. Valid return types are defined in XPathConstants . Conversion to the return type follows XPath conversion rules.
|
Summary
Public methods | |
---|---|
abstract XPathExpression! |
Compile an XPath expression for later evaluation. |
abstract Any! |
Evaluate an |
abstract String! |
Evaluate an XPath expression in the specified context and return the result as a |
abstract Any! |
evaluate(expression: String!, source: InputSource!, returnType: QName!) Evaluate an XPath expression in the context of the specified |
abstract String! |
evaluate(expression: String!, source: InputSource!) Evaluate an XPath expression in the context of the specified |
abstract NamespaceContext! |
Return the current namespace context. |
abstract XPathFunctionResolver! |
Return the current function resolver. |
abstract XPathVariableResolver! |
Return the current variable resolver. |
abstract Unit |
reset() Reset this |
abstract Unit |
setNamespaceContext(nsContext: NamespaceContext!) Establish a namespace context. |
abstract Unit |
setXPathFunctionResolver(resolver: XPathFunctionResolver!) Establish a function resolver. |
abstract Unit |
setXPathVariableResolver(resolver: XPathVariableResolver!) Establish a variable resolver. |
Public methods
compile
abstract fun compile(expression: String!): XPathExpression!
Compile an XPath expression for later evaluation.
If expression
contains any XPathFunction
s, they must be available via the XPathFunctionResolver
. An XPathExpressionException
will be thrown if the XPathFunction
cannot be resolved with the XPathFunctionResolver
.
If expression
is null
, a NullPointerException
is thrown.
Parameters | |
---|---|
expression |
String!: The XPath expression. |
Return | |
---|---|
XPathExpression! |
Compiled XPath expression. |
Exceptions | |
---|---|
javax.xml.xpath.XPathExpressionException |
If expression cannot be compiled. |
java.lang.NullPointerException |
If expression is null . |
evaluate
abstract fun evaluate(
expression: String!,
item: Any!,
returnType: QName!
): Any!
Evaluate an XPath
expression in the specified context and return the result as the specified type.
See Evaluation of XPath Expressions for context item evaluation, variable, function and QName
resolution and return type conversion.
If returnType
is not one of the types defined in XPathConstants
( NUMBER
, STRING
, BOOLEAN
, NODE
or NODESET
) then an IllegalArgumentException
is thrown.
If a null
value is provided for item
, an empty document will be used for the context. If expression
or returnType
is null
, then a NullPointerException
is thrown.
Parameters | |
---|---|
expression |
String!: The XPath expression. |
item |
Any!: The starting context (node or node list, for example). |
returnType |
QName!: The desired return type. |
Return | |
---|---|
Any! |
Result of evaluating an XPath expression as an Object of returnType . |
Exceptions | |
---|---|
javax.xml.xpath.XPathExpressionException |
If expression cannot be evaluated. |
java.lang.IllegalArgumentException |
If returnType is not one of the types defined in XPathConstants . |
java.lang.NullPointerException |
If expression or returnType is null . |
evaluate
abstract fun evaluate(
expression: String!,
item: Any!
): String!
Evaluate an XPath expression in the specified context and return the result as a String
.
This method calls evaluate(java.lang.String,java.lang.Object,javax.xml.namespace.QName)
with a returnType
of XPathConstants#STRING
.
See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.
If a null
value is provided for item
, an empty document will be used for the context. If expression
is null
, then a NullPointerException
is thrown.
Parameters | |
---|---|
expression |
String!: The XPath expression. |
item |
Any!: The starting context (node or node list, for example). |
Return | |
---|---|
String! |
The String that is the result of evaluating the expression and converting the result to a String . |
Exceptions | |
---|---|
javax.xml.xpath.XPathExpressionException |
If expression cannot be evaluated. |
java.lang.NullPointerException |
If expression is null . |
evaluate
abstract fun evaluate(
expression: String!,
source: InputSource!,
returnType: QName!
): Any!
Evaluate an XPath expression in the context of the specified InputSource
and return the result as the specified type.
This method builds a data model for the InputSource
and calls evaluate(java.lang.String,java.lang.Object,javax.xml.namespace.QName)
on the resulting document object.
See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.
If returnType
is not one of the types defined in XPathConstants
, then an IllegalArgumentException
is thrown.
If expression
, source
or returnType
is null
, then a NullPointerException
is thrown.
Parameters | |
---|---|
expression |
String!: The XPath expression. |
source |
InputSource!: The input source of the document to evaluate over. |
returnType |
QName!: The desired return type. |
Return | |
---|---|
Any! |
The Object that encapsulates the result of evaluating the expression. |
Exceptions | |
---|---|
javax.xml.xpath.XPathExpressionException |
If expression cannot be evaluated. |
java.lang.IllegalArgumentException |
If returnType is not one of the types defined in XPathConstants . |
java.lang.NullPointerException |
If expression , source or returnType is null . |
evaluate
abstract fun evaluate(
expression: String!,
source: InputSource!
): String!
Evaluate an XPath expression in the context of the specified InputSource
and return the result as a String
.
This method calls evaluate(java.lang.String,org.xml.sax.InputSource,javax.xml.namespace.QName)
with a returnType
of XPathConstants#STRING
.
See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.
If expression
or source
is null
, then a NullPointerException
is thrown.
Parameters | |
---|---|
expression |
String!: The XPath expression. |
source |
InputSource!: The InputSource of the document to evaluate over. |
Return | |
---|---|
String! |
The String that is the result of evaluating the expression and converting the result to a String . |
Exceptions | |
---|---|
javax.xml.xpath.XPathExpressionException |
If expression cannot be evaluated. |
java.lang.NullPointerException |
If expression or source is null . |
getNamespaceContext
abstract fun getNamespaceContext(): NamespaceContext!
Return the current namespace context.
null
is returned in no namespace context is in effect.
Return | |
---|---|
NamespaceContext! |
Current Namespace context. |
getXPathFunctionResolver
abstract fun getXPathFunctionResolver(): XPathFunctionResolver!
Return the current function resolver.
null
is returned in no function resolver is in effect.
Return | |
---|---|
XPathFunctionResolver! |
Current function resolver. |
getXPathVariableResolver
abstract fun getXPathVariableResolver(): XPathVariableResolver!
Return the current variable resolver.
null
is returned in no variable resolver is in effect.
Return | |
---|---|
XPathVariableResolver! |
Current variable resolver. |
reset
abstract fun reset(): Unit
Reset this XPath
to its original configuration.
XPath
is reset to the same state as when it was created with XPathFactory#newXPath()
. reset()
is designed to allow the reuse of existing XPath
s thus saving resources associated with the creation of new XPath
s.
The reset XPath
is not guaranteed to have the same XPathFunctionResolver
, XPathVariableResolver
or NamespaceContext
Object
s, e.g. Object#equals(Object obj)
. It is guaranteed to have a functionally equal XPathFunctionResolver
, XPathVariableResolver
and NamespaceContext
.
setNamespaceContext
abstract fun setNamespaceContext(nsContext: NamespaceContext!): Unit
Establish a namespace context.
A NullPointerException
is thrown if nsContext
is null
.
Parameters | |
---|---|
nsContext |
NamespaceContext!: Namespace context to use. |
Exceptions | |
---|---|
java.lang.NullPointerException |
If nsContext is null . |
setXPathFunctionResolver
abstract fun setXPathFunctionResolver(resolver: XPathFunctionResolver!): Unit
Establish a function resolver.
A NullPointerException
is thrown if resolver
is null
.
Parameters | |
---|---|
resolver |
XPathFunctionResolver!: XPath function resolver. |
Exceptions | |
---|---|
java.lang.NullPointerException |
If resolver is null . |
setXPathVariableResolver
abstract fun setXPathVariableResolver(resolver: XPathVariableResolver!): Unit
Establish a variable resolver.
A NullPointerException
is thrown if resolver
is null
.
Parameters | |
---|---|
resolver |
XPathVariableResolver!: Variable resolver. |
Exceptions | |
---|---|
java.lang.NullPointerException |
If resolver is null . |