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
018package org.apache.commons.jxpath;
019
020import java.util.List;
021
022/**
023 * 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
024 * List or Set), in which case it will be given a collection of <em>values</em> matching the path.
025 */
026public interface NodeSet {
027
028    /**
029     * Returns a list of nodes.
030     *
031     * @return List
032     */
033    List getNodes();
034
035    /**
036     * Returns a list of pointers for all nodes in the set.
037     *
038     * @return List
039     */
040    List<Pointer> getPointers();
041
042    /**
043     * Returns a list of values of all contained pointers.
044     *
045     * @return List
046     */
047    List getValues();
048}