diff -r 1d7e6da6adc8 -r c348e06f0e82 jaxp/src/javax/xml/xpath/XPathFunction.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/jaxp/src/javax/xml/xpath/XPathFunction.java Thu Apr 12 08:38:26 2012 -0700 @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2003, 2005, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +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 + * @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; +}