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;
  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  * @LastModified: Oct 2017
  31  */
  32 public interface XSObjectList extends List<XSObject> {
  33     /**
  34      *  The number of <code>XSObjects</code> in the list. The range of valid
  35      * child object indices is 0 to <code>length-1</code> inclusive.
  36      */
  37     public int getLength();
  38 
  39     /**
  40      *  Returns the <code>index</code>th item in the collection or
  41      * <code>null</code> if <code>index</code> is greater than or equal to
  42      * the number of objects in the list. The index starts at 0.
  43      * @param index  index into the collection.
  44      * @return  The <code>XSObject</code> at the <code>index</code>th
  45      *   position in the <code>XSObjectList</code>, or <code>null</code> if
  46      *   the index specified is not valid.
  47      */
  48     public XSObject item(int index);
  49 
  50 }