1 /* 2 * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved. 3 * @LastModified: Oct 2017 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 22 package com.sun.org.apache.xerces.internal.xs; 23 24 import java.util.Map; 25 import javax.xml.namespace.QName; 26 27 /** 28 * Objects implementing the <code>XSNamedMap</code> interface are used to 29 * represent immutable collections of XML Schema components that can be 30 * accessed by name. Note that <code>XSNamedMap</code> does not inherit from 31 * <code>XSObjectList</code>. The <code>XSObject</code>s in 32 * <code>XSNamedMap</code>s are not maintained in any particular order. 33 */ 34 public interface XSNamedMap extends Map<QName, XSObject> { 35 /** 36 * The number of <code>XSObjects</code> in the <code>XSObjectList</code>. 37 * The range of valid child object indices is 0 to <code>length-1</code> 38 * inclusive. 39 */ 40 public int getLength(); 41 42 /** 43 * Returns the <code>index</code>th item in the collection or 44 * <code>null</code> if <code>index</code> is greater than or equal to 45 * the number of objects in the list. The index starts at 0. 46 * @param index index into the collection. 47 * @return The <code>XSObject</code> at the <code>index</code>th 48 * position in the <code>XSObjectList</code>, or <code>null</code> if 49 * the index specified is not valid. 50 */ 51 public XSObject item(int index); 52 53 /** 54 * Retrieves an <code>XSObject</code> specified by local name and 55 * namespace URI. 56 * <br>Per XML Namespaces, applications must use the value <code>null</code> as the 57 * <code>namespace</code> parameter for methods if they wish to specify 58 * no namespace. 59 * @param namespace The namespace URI of the <code>XSObject</code> to 60 * retrieve, or <code>null</code> if the <code>XSObject</code> has no 61 * namespace. 62 * @param localName The local name of the <code>XSObject</code> to 63 * retrieve. 64 * @return A <code>XSObject</code> (of any type) with the specified local 65 * name and namespace URI, or <code>null</code> if they do not 66 * identify any object in this map. 67 */ 68 public XSObject itemByName(String namespace, 69 String localName); 70 71 }