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  
18  package org.apache.commons.jxpath;
19  
20  import java.util.List;
21  
22  /**
23   * NodeSet interface can be used as the type of an argument of an extension function. Alternatively, the function can declare the argument as a Collection (or
24   * List or Set), in which case it will be given a collection of <em>values</em> matching the path.
25   */
26  public interface NodeSet {
27  
28      /**
29       * Returns a list of nodes.
30       *
31       * @return List
32       */
33      List getNodes();
34  
35      /**
36       * Returns a list of pointers for all nodes in the set.
37       *
38       * @return List
39       */
40      List<Pointer> getPointers();
41  
42      /**
43       * Returns a list of values of all contained pointers.
44       *
45       * @return List
46       */
47      List getValues();
48  }