KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > w3c > dom > DOMStringList


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>DOMStringList</code> interface provides the abstraction of an
17  * ordered collection of <code>DOMString</code> values, without defining or
18  * constraining how this collection is implemented. The items in the
19  * <code>DOMStringList</code> are accessible via an integral index, starting
20  * 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  * @since DOM Level 3
23  */

24 public interface DOMStringList {
25     /**
26      * Returns the <code>index</code>th item in the collection. If
27      * <code>index</code> is greater than or equal to the number of
28      * <code>DOMString</code>s in the list, this returns <code>null</code>.
29      * @param index Index into the collection.
30      * @return The <code>DOMString</code> at the <code>index</code>th
31      * position in the <code>DOMStringList</code>, or <code>null</code> if
32      * that is not a valid index.
33      */

34     public String JavaDoc item(int index);
35
36     /**
37      * The number of <code>DOMString</code>s in the list. The range of valid
38      * child node indices is 0 to <code>length-1</code> inclusive.
39      */

40     public int getLength();
41
42     /**
43      * Test if a string is part of this <code>DOMStringList</code>.
44      * @param str The string to look for.
45      * @return <code>true</code> if the string has been found,
46      * <code>false</code> otherwise.
47      */

48     public boolean contains(String JavaDoc str);
49
50 }
51
Popular Tags