1 /*
   2  * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.

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