1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * This code is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 only, as
6 * published by the Free Software Foundation. Sun designates this
7 * particular file as subject to the "Classpath" exception as provided
8 * by Sun in the LICENSE file that accompanied this code.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
22 * have any questions.
23 */
24
25 /*
26 * This file is available under and governed by the GNU General Public
27 * License version 2 only, as published by the Free Software Foundation.
28 * However, the following notice accompanied the original version of this
29 * file and, per its terms, should not be removed:
30 *
31 * Copyright (c) 2004 World Wide Web Consortium,
32 *
33 * (Massachusetts Institute of Technology, European Research Consortium for
34 * Informatics and Mathematics, Keio University). All Rights Reserved. This
35 * work is distributed under the W3C(r) Software License [1] in the hope that
36 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
37 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
38 *
39 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
40 */
41
42 package org.w3c.dom;
43
44 /**
45 * The <code>DOMStringList</code> interface provides the abstraction of an
46 * ordered collection of <code>DOMString</code> values, without defining or
47 * constraining how this collection is implemented. The items in the
48 * <code>DOMStringList</code> are accessible via an integral index, starting
49 * from 0.
50 * <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>.
51 * @since DOM Level 3
52 */
53 public interface DOMStringList {
54 /**
55 * Returns the <code>index</code>th item in the collection. If
56 * <code>index</code> is greater than or equal to the number of
57 * <code>DOMString</code>s in the list, this returns <code>null</code>.
58 * @param index Index into the collection.
59 * @return The <code>DOMString</code> at the <code>index</code>th
60 * position in the <code>DOMStringList</code>, or <code>null</code> if
61 * that is not a valid index.
62 */
63 public String item(int index);
64
65 /**
66 * The number of <code>DOMString</code>s in the list. The range of valid
67 * child node indices is 0 to <code>length-1</code> inclusive.
68 */
69 public int getLength();
70
71 /**
72 * Test if a string is part of this <code>DOMStringList</code>.
73 * @param str The string to look for.
74 * @return <code>true</code> if the string has been found,
75 * <code>false</code> otherwise.
76 */
77 public boolean contains(String str);
78
79 }
Save This Page