// $Id: XPathFunction.java,v 1.10 2004/02/11 20:14:32 ndw Exp $ /* * @(#)XPathFunction.java 1.5 04/07/26 * * Copyright 2004 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.xml.xpath; import java.util.List; /** *
XPathFunction
provides access to XPath functions.
Functions are identified by QName and arity in XPath.
* * @author Norman Walsh * @author Jeff Suttor * @version $Revision: 1.10 $, $Date: 2004/02/11 20:14:32 $ * @since 1.5 */ public interface XPathFunction { /** *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.
* * @param args The arguments,null
is a valid value.
*
* @return The result of evaluating the XPath
function as an Object
.
*
* @throws XPathFunctionException If args
cannot be evaluated with this XPath
function.
*/
public Object evaluate(List args)
throws XPathFunctionException;
}