XPathFunction
Keywords: javax.xml.xpath.XPathFunction interface

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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

Method Summary
`java.lang.Object` | `evaluate(java.util.List args)` Evaluate the function with the specified arguments.

Method Detail

### evaluate

    public java.lang.Object evaluate(java.util.List args)
                              throws XPathFunctionException

  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.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD