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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xercesImpl Show documentation

Xerces2 is the next generation of high performance, fully compliant XML parsers in the Apache Xerces family. This new version of Xerces introduces the Xerces Native Interface (XNI), a complete framework for building parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is the reference implementation of XNI but other parser components, configurations, and parsers can be written using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual. Xerces2 is a fully conforming XML Schema 1.0 processor. A partial experimental implementation of the XML Schema 1.1 Structures and Datatypes Working Drafts (December 2009) and an experimental implementation of the XML Schema Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010) are provided for evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that it does not yet provide an option to enable normalization checking as described in section 2.13 of this specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use.

The newest version!

/*
 * 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);

}