Java example source code file (XSNamedMap.java)

This example Java source code file (XSNamedMap.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

map, string, util, xsnamedmap, xsobject

The XSNamedMap.java Java example source code

/*
 * reserved comment block
 * DO NOT REMOVE OR ALTER!
 */
/*
 * Copyright 2003,2004 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.sun.org.apache.xerces.internal.xs;

import java.util.Map;

/**
 * Objects implementing the <code>XSNamedMap interface are used to
 * represent immutable collections of XML Schema components that can be
 * accessed by name. Note that <code>XSNamedMap does not inherit from
 * <code>XSObjectList. The XSObjects in
 * <code>XSNamedMaps are not maintained in any particular order.
 */
public interface XSNamedMap extends Map {
    /**
     * The number of <code>XSObjects in the XSObjectList.
     * The range of valid child object indices is 0 to <code>length-1
     * inclusive.
     */
    public int getLength();

    /**
     *  Returns the <code>indexth item in the collection or
     * <code>null if index is greater than or equal to
     * the number of objects in the list. The index starts at 0.
     * @param index  index into the collection.
     * @return  The <code>XSObject at the indexth
     *   position in the <code>XSObjectList, or null if
     *   the index specified is not valid.
     */
    public XSObject item(int index);

    /**
     * Retrieves an <code>XSObject specified by local name and
     * namespace URI.
     * <br>Per XML Namespaces, applications must use the value null as the
     * <code>namespace parameter for methods if they wish to specify
     * no namespace.
     * @param namespace The namespace URI of the <code>XSObject to
     *   retrieve, or <code>null if the XSObject has no
     *   namespace.
     * @param localName The local name of the <code>XSObject to
     *   retrieve.
     * @return A <code>XSObject (of any type) with the specified local
     *   name and namespace URI, or <code>null if they do not
     *   identify any object in this map.
     */
    public XSObject itemByName(String namespace,
                               String localName);

}