1 /*
   2  * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.xpath;
  27 
  28 import java.util.Iterator;
  29 import org.w3c.dom.Node;
  30 
  31 /**
  32  * XPathNodes represents a set of nodes selected by a location path as specified
  33  * in <a href="http://www.w3.org/TR/xpath/#node-sets">XML Path Language (XPath)
  34  * Version 1.0, 3.3 Node-sets</a>.
  35  *
  36  * @since 1.9
  37  */
  38 public interface XPathNodes extends Iterable<Node> {
  39 
  40     /**
  41      * Returns an iterator of the Nodes.
  42      *
  43      * @return an Iterator.
  44      */
  45     @Override
  46     public abstract Iterator<Node> iterator();
  47 
  48     /**
  49      * Returns the number of items in the result
  50      *
  51      * @return The number of items in the result
  52      */
  53     public abstract int size();
  54 
  55     /**
  56      * Returns a Node at the specified position
  57      *
  58      * @param index Index of the element to return.
  59      * @return The Node at the specified position.
  60      * @throws javax.xml.xpath.XPathException If the index is out of range
  61      * (index &lt; 0 || index &gt;= size())
  62      */
  63     public abstract Node get(int index)
  64             throws XPathException;
  65 }