libjava/org/w3c/dom/NodeList.java

   1 /*
   2  * Copyright (c) 2000 World Wide Web Consortium,
   3  * (Massachusetts Institute of Technology, Institut National de
   4  * Recherche en Informatique et en Automatique, Keio University). All
   5  * Rights Reserved. This program is distributed under the W3C's Software
   6  * Intellectual Property License. This program is distributed in the
   7  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
   8  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
   9  * PURPOSE.
  10  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
  11  */
  12
  13 package org.w3c.dom;
  14
  15 /**
  16  * The <code>NodeList</code> interface provides the abstraction of an ordered
  17  * collection of nodes, without defining or constraining how this collection
  18  * is implemented. <code>NodeList</code> objects in the DOM are live.
  19  * <p>The items in the <code>NodeList</code> are accessible via an integral
  20  * index, starting from 0.
  21  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113'>Document Object Model (DOM) Level 2 Core Specification</a>.
  22  */
  23 public interface NodeList {
  24     /**
  25      * Returns the <code>index</code>th item in the collection. If
  26      * <code>index</code> is greater than or equal to the number of nodes in
  27      * the list, this returns <code>null</code>.
  28      * @param indexIndex into the collection.
  29      * @return The node at the <code>index</code>th position in the
  30      *   <code>NodeList</code>, or <code>null</code> if that is not a valid
  31      *   index.
  32      */
  33     public Node item(int index);
  34
  35     /**
  36      * The number of nodes in the list. The range of valid child node indices
  37      * is 0 to <code>length-1</code> inclusive.
  38      */
  39     public int getLength();
  40
  41 }