1/*
2 * reserved comment block
3 * DO NOT REMOVE OR ALTER!
4 */
5/*
6 * Licensed to the Apache Software Foundation (ASF) under one or more
7 * contributor license agreements.  See the NOTICE file distributed with
8 * this work for additional information regarding copyright ownership.
9 * The ASF licenses this file to You under the Apache License, Version 2.0
10 * (the "License"); you may not use this file except in compliance with
11 * the License.  You may obtain a copy of the License at
12 *
13 *      http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 */
21
22package com.sun.org.apache.xerces.internal.xs;
23
24import java.util.Map;
25
26/**
27 * Objects implementing the <code>XSNamedMap</code> interface are used to
28 * represent immutable collections of XML Schema components that can be
29 * accessed by name. Note that <code>XSNamedMap</code> does not inherit from
30 * <code>XSObjectList</code>. The <code>XSObject</code>s in
31 * <code>XSNamedMap</code>s are not maintained in any particular order.
32 */
33public interface XSNamedMap extends Map {
34    /**
35     * The number of <code>XSObjects</code> in the <code>XSObjectList</code>.
36     * The range of valid child object indices is 0 to <code>length-1</code>
37     * inclusive.
38     */
39    public int getLength();
40
41    /**
42     *  Returns the <code>index</code>th item in the collection or
43     * <code>null</code> if <code>index</code> is greater than or equal to
44     * the number of objects in the list. The index starts at 0.
45     * @param index  index into the collection.
46     * @return  The <code>XSObject</code> at the <code>index</code>th
47     *   position in the <code>XSObjectList</code>, or <code>null</code> if
48     *   the index specified is not valid.
49     */
50    public XSObject item(int index);
51
52    /**
53     * Retrieves an <code>XSObject</code> specified by local name and
54     * namespace URI.
55     * <br>Per XML Namespaces, applications must use the value <code>null</code> as the
56     * <code>namespace</code> parameter for methods if they wish to specify
57     * no namespace.
58     * @param namespace The namespace URI of the <code>XSObject</code> to
59     *   retrieve, or <code>null</code> if the <code>XSObject</code> has no
60     *   namespace.
61     * @param localName The local name of the <code>XSObject</code> to
62     *   retrieve.
63     * @return A <code>XSObject</code> (of any type) with the specified local
64     *   name and namespace URI, or <code>null</code> if they do not
65     *   identify any object in this map.
66     */
67    public XSObject itemByName(String namespace,
68                               String localName);
69
70}
71