View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.jxpath;
18  
19  import java.util.Set;
20  
21  /**
22   * A group of Function objects sharing a common namespace or a set of
23   * common namespaces. Use the classes
24   * {@link ClassFunctions ClassFunctions} and
25   * {@link PackageFunctions PackageFunctions}
26   * to register extension functions implemented as Java methods.
27   *
28   * @author Dmitri Plotnikov
29   * @version $Revision: 652845 $ $Date: 2008-05-02 13:46:46 -0400 (Fri, 02 May 2008) $
30   */
31  public interface Functions {
32  
33      /**
34       * Returns all namespaces in which this function collection defines
35       * functions.
36       * @return Set
37       */
38      Set getUsedNamespaces();
39  
40      /**
41       * Returns a Function, if any, for the specified namespace,
42       * name and parameter types.
43       * @param namespace ns
44       * @param name function name
45       * @param parameters Object[]
46       * @return Function
47       */
48      Function getFunction(String namespace, String name, Object[] parameters);
49  }