XPathFunction
Stay organized with collections
Save and categorize content based on your preferences.
XPathFunction provides access to XPath functions.
Functions are identified by QName and arity in XPath.
Public Methods
public
abstract
Object
evaluate
(List args)
Evaluate the function with the specified arguments.
To the greatest extent possible, side-effects should be avoided in the
definition of extension functions. The implementation evaluating an
XPath expression is under no obligation to call extension functions in
any particular order or any particular number of times.
Parameters
| args |
The arguments, null is a valid value. |
Returns
- The result of evaluating the
XPath function as an Object.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-10 UTC."],[[["\u003cp\u003e\u003ccode\u003eXPathFunction\u003c/code\u003e provides access to XPath functions, which are identified by QName and arity.\u003c/p\u003e\n"],["\u003cp\u003eThe primary method, \u003ccode\u003eevaluate\u003c/code\u003e, takes a list of arguments and returns the result of the function evaluation as an Object.\u003c/p\u003e\n"],["\u003cp\u003eImplementations of \u003ccode\u003eevaluate\u003c/code\u003e should avoid side-effects, as the order and frequency of calls are not guaranteed.\u003c/p\u003e\n"],["\u003cp\u003eIf the provided arguments are incompatible with the function, an \u003ccode\u003eXPathFunctionException\u003c/code\u003e is thrown.\u003c/p\u003e\n"]]],[],null,["# XPathFunction\n\npublic interface **XPathFunction** \n\u003cbr /\u003e\n\n`XPathFunction` provides access to XPath functions.\n\nFunctions are identified by QName and arity in XPath.\n\n\u003cbr /\u003e\n\n### Public Method Summary\n\n|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [Object](../../../../reference/java/lang/Object.html) | [evaluate](../../../../reference/javax/xml/xpath/XPathFunction.html#evaluate(java.util.List))([List](../../../../reference/java/util/List.html) args) Evaluate the function with the specified arguments. |\n\nPublic Methods\n--------------\n\n#### public abstract [Object](../../../../reference/java/lang/Object.html)\n**evaluate**\n([List](../../../../reference/java/util/List.html) args)\n\n\u003cbr /\u003e\n\nEvaluate the function with the specified arguments.\n\nTo the greatest extent possible, side-effects should be avoided in the\ndefinition of extension functions. The implementation evaluating an\nXPath expression is under no obligation to call extension functions in\nany particular order or any particular number of times.\n\n\u003cbr /\u003e\n\n##### Parameters\n\n| args | The arguments, `null` is a valid value. |\n|------|-----------------------------------------|\n\n##### Returns\n\n- The result of evaluating the `XPath` function as an `Object`. \n\n##### Throws\n\n| [XPathFunctionException](../../../../reference/javax/xml/xpath/XPathFunctionException.html) | If `args` cannot be evaluated with this `XPath` function. |\n|---------------------------------------------------------------------------------------------|-----------------------------------------------------------|"]]
