org.w3c.dom.NameList Maven / Gradle / Ivy

/*
 * Copyright (c) 2004 World Wide Web Consortium,
 *
 * (Massachusetts Institute of Technology, European Research Consortium for
 * Informatics and Mathematics, Keio University). All Rights Reserved. This
 * work is distributed under the W3C(r) Software License [1] in the hope that
 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
 */

package org.w3c.dom;

/**
 *  The NameList interface provides the abstraction of an ordered
 * collection of parallel pairs of name and namespace values (which could be
 * null values), without defining or constraining how this collection is
 * implemented. The items in the NameList are accessible via an
 * integral index, starting from 0.
 * See also the Document Object Model (DOM) Level 3 Core Specification.
 * @since DOM Level 3
 */
public interface NameList {
    /**
     *  Returns the indexth name item in the collection.
     * @param index Index into the collection.
     * @return  The name at the indexth position in the
     *   NameList, or null if there is no name for
     *   the specified index or if the index is out of range.
     */
    public String getName(int index);

    /**
     *  Returns the indexth namespaceURI item in the collection.
     * @param index Index into the collection.
     * @return  The namespace URI at the indexth position in the
     *   NameList, or null if there is no name for
     *   the specified index or if the index is out of range.
     */
    public String getNamespaceURI(int index);

    /**
     *  The number of pairs (name and namespaceURI) in the list. The range of
     * valid child node indices is 0 to length-1 inclusive.
     */
    public int getLength();

    /**
     *  Test if a name is part of this NameList.
     * @param str  The name to look for.
     * @return  true if the name has been found,
     *   false otherwise.
     */
    public boolean contains(String str);

    /**
     *  Test if the pair namespaceURI/name is part of this
     * NameList.
     * @param namespaceURI  The namespace URI to look for.
     * @param name  The name to look for.
     * @return  true if the pair namespaceURI/name has been
     *   found, false otherwise.
     */
    public boolean containsNS(String namespaceURI,
                              String name);

}