001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.commons.jxpath;
018    
019    import java.util.List;
020    
021    /**
022     * NodeSet interface can be used as the type of an argument of an extension
023     * function.  Alternatively, the function can declare the argument as
024     * a Collection (or List or Set), in which case it will be given a collection
025     * of <i>values</i> matching the path.
026     *
027     * @author <a href="mailto:dmitri@apache.org">Dmitri Plotnikov</a>
028     * @version $Id: NodeSet.java 618149 2008-02-04 02:04:13Z mbenson $
029     */
030    public interface NodeSet {
031    
032        /**
033         * Returns a list of nodes.
034         * @return List
035         */
036        List getNodes();
037    
038        /**
039         * Returns a list of pointers for all nodes in the set.
040         * @return List
041         */
042        List getPointers();
043    
044        /**
045         * Returns a list of values of all contained pointers.
046         * @return List
047         */
048        List getValues();
049    
050    }