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.List;
20
21 /**
22 * NodeSet interface can be used as the type of an argument of an extension
23 * function. Alternatively, the function can declare the argument as
24 * a Collection (or List or Set), in which case it will be given a collection
25 * of <i>values</i> matching the path.
26 *
27 * @author <a href="mailto:dmitri@apache.org">Dmitri Plotnikov</a>
28 * @version $Id: NodeSet.java 618149 2008-02-04 02:04:13Z mbenson $
29 */
30 public interface NodeSet {
31
32 /**
33 * Returns a list of nodes.
34 * @return List
35 */
36 List getNodes();
37
38 /**
39 * Returns a list of pointers for all nodes in the set.
40 * @return List
41 */
42 List getPointers();
43
44 /**
45 * Returns a list of values of all contained pointers.
46 * @return List
47 */
48 List getValues();
49
50 }