XSNamedMap


1   /*
2    * The Apache Software License, Version 1.1
3    *
4    *
5    * Copyright (c) 2003 The Apache Software Foundation.  All rights
6    * reserved.
7    *
8    * Redistribution and use in source and binary forms, with or without
9    * modification, are permitted provided that the following conditions
10   * are met:
11   *
12   * 1. Redistributions of source code must retain the above copyright
13   *    notice, this list of conditions and the following disclaimer.
14   *
15   * 2. Redistributions in binary form must reproduce the above copyright
16   *    notice, this list of conditions and the following disclaimer in
17   *    the documentation and/or other materials provided with the
18   *    distribution.
19   *
20   * 3. The end-user documentation included with the redistribution,
21   *    if any, must include the following acknowledgment:
22   *       "This product includes software developed by the
23   *        Apache Software Foundation (http://www.apache.org/)."
24   *    Alternately, this acknowledgment may appear in the software itself,
25   *    if and wherever such third-party acknowledgments normally appear.
26   *
27   * 4. The names "Xerces" and "Apache Software Foundation" must
28   *    not be used to endorse or promote products derived from this
29   *    software without prior written permission. For written
30   *    permission, please contact apache@apache.org.
31   *
32   * 5. Products derived from this software may not be called "Apache",
33   *    nor may "Apache" appear in their name, without prior written
34   *    permission of the Apache Software Foundation.
35   *
36   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47   * SUCH DAMAGE.
48   * ====================================================================
49   *
50   * This software consists of voluntary contributions made by many
51   * individuals on behalf of the Apache Software Foundation and was
52   * originally based on software copyright (c) 2003, International
53   * Business Machines, Inc., http://www.apache.org.  For more
54   * information on the Apache Software Foundation, please see
55   * <http://www.apache.org/>.
56   */
57  
58  package com.sun.org.apache.xerces.internal.xs;
59  
60  /**
61   * Objects implementing the <code>XSNamedMap</code> interface are used to 
62   * represent immutable collections of XML Schema components that can be 
63   * accessed by name. Note that <code>XSNamedMap</code> does not inherit from 
64   * <code>XSObjectList</code>. The <code>XSObject</code>s in 
65   * <code>XSNamedMap</code>s are not maintained in any particular order. 
66   */
67  public interface XSNamedMap {
68      /**
69       * The number of <code>XSObjects</code> in the <code>XSObjectList</code>. 
70       * The range of valid child object indices is 0 to <code>length-1</code> 
71       * inclusive. 
72       */
73      public int getLength();
74  
75      /**
76       *  Returns the <code>index</code>th item in the collection or 
77       * <code>null</code> if <code>index</code> is greater than or equal to 
78       * the number of objects in the list. The index starts at 0. 
79       * @param index  index into the collection. 
80       * @return  The <code>XSObject</code> at the <code>index</code>th 
81       *   position in the <code>XSObjectList</code>, or <code>null</code> if 
82       *   the index specified is not valid. 
83       */
84      public XSObject item(int index);
85  
86      /**
87       * Retrieves an <code>XSObject</code> specified by local name and 
88       * namespace URI.
89       * <br>Per XML Namespaces, applications must use the value <code>null</code> as the 
90       * <code>namespace</code> parameter for methods if they wish to specify 
91       * no namespace.
92       * @param namespace The namespace URI of the <code>XSObject</code> to 
93       *   retrieve, or <code>null</code> if the <code>XSObject</code> has no 
94       *   namespace. 
95       * @param localName The local name of the <code>XSObject</code> to 
96       *   retrieve.
97       * @return A <code>XSObject</code> (of any type) with the specified local 
98       *   name and namespace URI, or <code>null</code> if they do not 
99       *   identify any object in this map.
100      */
101     public XSObject itemByName(String   namespace, 
102                                String   localName);
103 
104 }
105
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags