1 /*
2  * reserved comment block
3  * DO NOT REMOVE OR ALTER!
4  */
5 /*
6  * Copyright 2004,2005 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 package com.sun.org.apache.xerces.internal.xs.datatypes;
21 
22 import java.util.List;
23 
24 /**
25  * <p>The <code>ObjectList</code> is an immutable ordered collection of
26  * <code>Object</code>.</p>
27  *
28  * @author Ankit Pasricha, IBM
29  *
30  * @version $Id: ObjectList.java,v 1.7 2010-11-01 04:40:31 joehw Exp $
31  */
32 public interface ObjectList extends List {
33 
34     /**
35      * The number of <code>Object</code>s in the list. The range of
36      * valid child object indices is 0 to <code>length-1</code> inclusive.
37      */
getLength()38     public int getLength();
39 
40     /**
41      * Checks if the <code>Object</code> <code>item</code> is a
42      * member of this list.
43      * @param item  <code>Object</code> whose presence in this list
44      *   is to be tested.
45      * @return  True if this list contains the <code>Object</code>
46      *   <code>item</code>.
47      */
contains(Object item)48     public boolean contains(Object item);
49 
50     /**
51      * Returns the <code>index</code>th item in the collection or
52      * <code>null</code> if <code>index</code> is greater than or equal to
53      * the number of objects in the list. The index starts at 0.
54      * @param index  index into the collection.
55      * @return  The <code>Object</code> at the <code>index</code>th
56      *   position in the <code>ObjectList</code>, or <code>null</code> if
57      *   the index specified is not valid - greater than or equal to the
58      *   number of items in the list or less than zero.
59      */
item(int index)60     public Object item(int index);
61 
62 }
63