NameList.java revision 628:2bfaf29cc90b 
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.  Oracle designates this
7 * particular file as subject to the "Classpath" exception as provided
8 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * 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
42package org.w3c.dom;
43
44/**
45 *  The <code>NameList</code> interface provides the abstraction of an ordered
46 * collection of parallel pairs of name and namespace values (which could be
47 * null values), without defining or constraining how this collection is
48 * implemented. The items in the <code>NameList</code> are accessible via an
49 * integral index, starting 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 1.5, DOM Level 3
52 */
53public interface NameList {
54    /**
55     *  Returns the <code>index</code>th name item in the collection.
56     * @param index Index into the collection.
57     * @return  The name at the <code>index</code>th position in the
58     *   <code>NameList</code>, or <code>null</code> if there is no name for
59     *   the specified index or if the index is out of range.
60     */
61    public String getName(int index);
62
63    /**
64     *  Returns the <code>index</code>th namespaceURI item in the collection.
65     * @param index Index into the collection.
66     * @return  The namespace URI at the <code>index</code>th position in the
67     *   <code>NameList</code>, or <code>null</code> if there is no name for
68     *   the specified index or if the index is out of range.
69     */
70    public String getNamespaceURI(int index);
71
72    /**
73     *  The number of pairs (name and namespaceURI) in the list. The range of
74     * valid child node indices is 0 to <code>length-1</code> inclusive.
75     */
76    public int getLength();
77
78    /**
79     *  Test if a name is part of this <code>NameList</code>.
80     * @param str  The name to look for.
81     * @return  <code>true</code> if the name has been found,
82     *   <code>false</code> otherwise.
83     */
84    public boolean contains(String str);
85
86    /**
87     *  Test if the pair namespaceURI/name is part of this
88     * <code>NameList</code>.
89     * @param namespaceURI  The namespace URI to look for.
90     * @param name  The name to look for.
91     * @return  <code>true</code> if the pair namespaceURI/name has been
92     *   found, <code>false</code> otherwise.
93     */
94    public boolean containsNS(String namespaceURI,
95                              String name);
96
97}
98