javax.xml.xpath

Interface XPathFunction

public interface XPathFunction

XPathFunction provides access to XPath functions.

Functions are identified by QName and arity in XPath.

Since: 1.5

Version: $Revision: 226183 $, $Date: 2005-04-08 06:39:14 -0400 (Fri, 08 Apr 2005) $

Author: Norman Walsh Jeff Suttor

Method Summary
Objectevaluate(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.

Method Detail

evaluate

public 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.

Throws: XPathFunctionException If args cannot be evaluated with this XPath function.