org.apache.xerces.xs.datatypes.ObjectList Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.xerces.xs.datatypes;

import java.util.List;

/**
 * The ObjectList is an immutable ordered collection of 
 * Object. 
 * 
 * @author Ankit Pasricha, IBM
 * 
 * @version $Id: ObjectList.java 744816 2009-02-16 06:03:18Z mrglavas $
 */
public interface ObjectList extends List {
    
    /**
     * The number of Objects in the list. The range of 
     * valid child object indices is 0 to length-1 inclusive. 
     */
    public int getLength();
    
    /**
     * Checks if the Object item is a 
     * member of this list. 
     * @param item  Object whose presence in this list 
     *   is to be tested. 
     * @return  True if this list contains the Object 
     *   item. 
     */
    public boolean contains(Object item);
    
    /**
     * Returns the indexth item in the collection or 
     * null if index is greater than or equal to 
     * the number of objects in the list. The index starts at 0. 
     * @param index  index into the collection. 
     * @return  The Object at the indexth 
     *   position in the ObjectList, or null if 
     *   the index specified is not valid - greater than or equal to the
     *   number of items in the list or less than zero. 
     */
    public Object item(int index);
    
}