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.datatypes;
  22 
  23 import java.util.List;
  24 
  25 /**
  26  * <p>The <code>ObjectList</code> is an immutable ordered collection of
  27  * <code>Object</code>.</p>
  28  *
  29  * @author Ankit Pasricha, IBM
  30  *
  31  * @LastModified: Oct 2017
  32  */
  33 public interface ObjectList extends List<Object> {
  34 
  35     /**
  36      * The number of <code>Object</code>s in the list. The range of
  37      * valid child object indices is 0 to <code>length-1</code> inclusive.
  38      */
  39     public int getLength();
  40 
  41     /**
  42      * Checks if the <code>Object</code> <code>item</code> is a
  43      * member of this list.
  44      * @param item  <code>Object</code> whose presence in this list
  45      *   is to be tested.
  46      * @return  True if this list contains the <code>Object</code>
  47      *   <code>item</code>.
  48      */
  49     public boolean contains(Object item);
  50 
  51     /**
  52      * Returns the <code>index</code>th item in the collection or
  53      * <code>null</code> if <code>index</code> is greater than or equal to
  54      * the number of objects in the list. The index starts at 0.
  55      * @param index  index into the collection.
  56      * @return  The <code>Object</code> at the <code>index</code>th
  57      *   position in the <code>ObjectList</code>, or <code>null</code> if
  58      *   the index specified is not valid - greater than or equal to the
  59      *   number of items in the list or less than zero.
  60      */
  61     public Object item(int index);
  62 
  63 }