/*
 * 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.impl.xs.util;

import java.util.AbstractList;

import org.apache.xerces.xs.ShortList;
import org.apache.xerces.xs.XSException;

Contains a list of shorts.
Author:
Sandy Gao, IBM
@xerces.internal
Version:
$Id: ShortListImpl.java 725840 2008-12-11 22:19:06Z mrglavas $/**
 * Contains a list of shorts.
 *
 * @xerces.internal 
 *
 * @author Sandy Gao, IBM
 *
 * @version $Id: ShortListImpl.java 725840 2008-12-11 22:19:06Z mrglavas $
 */
public final class ShortListImpl extends AbstractList implements ShortList {

    
An immutable empty list.
/**
     * An immutable empty list.
     */
    public static final ShortListImpl EMPTY_LIST = new ShortListImpl(new short[0], 0);
    
    // The array to hold all data
    private final short[] fArray;
    // Number of elements in this list
    private final int fLength;

    
Construct an XSObjectList implementation
Params:
array –     the data array
length –    the number of elements/**
     * Construct an XSObjectList implementation
     * 
     * @param array     the data array
     * @param length    the number of elements
     */
    public ShortListImpl(short[] array, int length) {
        fArray = array;
        fLength = length;
    }

    
The number of Objects in the list. The range of valid
child node indices is 0 to length-1 inclusive.
/**
     * The number of <code>Objects</code> in the list. The range of valid
     * child node indices is 0 to <code>length-1</code> inclusive.
     */
    public int getLength() {
        return fLength;
    }

    
 Checks if the unsigned short item is a 
member of this list. 
Params:
item –  unsigned short whose presence in this list 
  is to be tested.
Returns:
 True if this list contains the unsigned short 
  item./**
     *  Checks if the <code>unsigned short</code> <code>item</code> is a 
     * member of this list. 
     * @param item  <code>unsigned short</code> whose presence in this list 
     *   is to be tested. 
     * @return  True if this list contains the <code>unsigned short</code> 
     *   <code>item</code>. 
     */
    public boolean contains(short item) {
        for (int i = 0; i < fLength; i++) {
            if (fArray[i] == item) {
                return true;
            }
        }
        return false;
    }
    
    public short item(int index) throws XSException {
        if (index < 0 || index >= fLength) {
            throw new XSException(XSException.INDEX_SIZE_ERR, null);
        }
        return fArray[index];
    }
    
    public boolean equals(Object obj) {
        if (obj == null || !(obj instanceof ShortList)) {
            return false;
        }
        ShortList rhs = (ShortList)obj;
        
        if (fLength != rhs.getLength()) {
            return false;
        }
        for (int i = 0;i < fLength; ++i) {
            if (fArray[i] != rhs.item(i)) {
                return false;
            }
        }
        return true;
    }
    
    /*
     * List methods
     */

    public Object get(int index) {
        if (index >= 0 && index < fLength) {
            return new Short(fArray[index]);
        }
        throw new IndexOutOfBoundsException("Index: " + index);
    }

    public int size() {
        return getLength();
    }

} // class ShortListImpl