XPathFunction (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

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.

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

Method Detail

evaluate

public Object evaluate(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.