View Javadoc
1   /*
2    * reserved comment block
3    * DO NOT REMOVE OR ALTER!
4    */
5   /*
6    * Copyright 2003,2004 The Apache Software Foundation.
7    *
8    * Licensed under the Apache License, Version 2.0 (the "License");
9    * you may not use this file except in compliance with the License.
10   * 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.List;
24  
25  /**
26   *  The <code>XSObjectList</code> interface provides the abstraction of an
27   * immutable ordered collection of <code>XSObject</code>s, without defining
28   * or constraining how this collection is implemented.
29   */
30  public interface XSObjectList extends List {
31      /**
32       *  The number of <code>XSObjects</code> in the list. The range of valid
33       * child object indices is 0 to <code>length-1</code> inclusive.
34       */
35      public int getLength();
36  
37      /**
38       *  Returns the <code>index</code>th item in the collection or
39       * <code>null</code> if <code>index</code> is greater than or equal to
40       * the number of objects in the list. The index starts at 0.
41       * @param index  index into the collection.
42       * @return  The <code>XSObject</code> at the <code>index</code>th
43       *   position in the <code>XSObjectList</code>, or <code>null</code> if
44       *   the index specified is not valid.
45       */
46      public XSObject item(int index);
47  
48  }