Home | History | Annotate | Download | only in dom
      1 /*
      2  * Copyright (c) 2004 World Wide Web Consortium,
      3  *
      4  * (Massachusetts Institute of Technology, European Research Consortium for
      5  * Informatics and Mathematics, Keio University). All Rights Reserved. This
      6  * work is distributed under the W3C(r) Software License [1] in the hope that
      7  * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
      8  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
      9  *
     10  * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
     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/2004/REC-DOM-Level-3-Core-20040407'>Document Object Model (DOM) Level 3 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 index Index 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 }
     42