View Javadoc

1   /*
2    * Copyright 2003-2004 The Apache Software Foundation
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.apache.commons.jxpath;
17  
18  import java.util.List;
19  
20  /***
21   * NodeSet interface can be used as the type of an argument of an extension
22   * function.  Alternatively, the function can declare the argument as
23   * a Collection (or List or Set), in which case it will be given a collection
24   * of <i>values</i> matching the path.
25   * 
26   * @author <a href="mailto:dmitri@apache.org">Dmitri Plotnikov</a>
27   * @version $Id: NodeSet.java,v 1.3 2004/02/29 14:17:42 scolebourne Exp $
28   */
29  public interface NodeSet {
30  
31      /***
32       * Returns a list of nodes.
33       */
34      List getNodes();
35      
36      /***
37       * Returns a list of pointers for all nodes in the set.
38       */
39      List getPointers();
40      
41      /***
42       * Returns a list of values of all contained pointers.
43       */
44      List getValues();
45      
46  }