jodd.util.collection.IntArrayList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of extractor Show documentation
Web Data Extractor - Extract data from common web format. like HTML,XML,JSON.
The newest version!
// Copyright (c) 2003-present, Jodd Team (http://jodd.org)
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

package jodd.util.collection;

/**
 * ArrayList of int primitives. For just buffering values, consider
 * using FastIntBuffer.
 */
public class IntArrayList {

    private int[] array;
    private int size;

    public static int initialCapacity = 10;

    /**
     * Constructs an empty list with an initial capacity.
     */
    public IntArrayList() {
        this(initialCapacity);
    }

    /**
     * Constructs an empty list with the specified initial capacity.
     */
    public IntArrayList(int initialCapacity) {
        if (initialCapacity < 0) {
            throw new IllegalArgumentException("Invalid capacity: " + initialCapacity);
        }
        array = new int[initialCapacity];
        size = 0;
    }

    /**
     * Constructs a list containing the elements of the specified array.
     * The list instance has an initial capacity of 110% the size of the specified array.
     */
    public IntArrayList(int[] data) {
        array = new int[(int) (data.length * 1.1) + 1];
        size = data.length;
        System.arraycopy(data, 0, array, 0, size);
    }

    // ---------------------------------------------------------------- conversion

    /**
     * Returns an array containing all of the elements in this list in the correct order.
     */
    public int[] toArray() {
        int[] result = new int[size];
        System.arraycopy(array, 0, result, 0, size);
        return result;
    }

    // ---------------------------------------------------------------- methods

    /**
     * Returns the element at the specified position in this list.
     */
    public int get(int index) {
        checkRange(index);
        return array[index];
    }

    /**
     * Returns the number of elements in this list.
     */
    public int size() {
        return size;
    }

    /**
     * Removes the element at the specified position in this list.
     * Shifts any subsequent elements to the left (subtracts
     * one from their indices).
     *
     * @param index the index of the element to remove
     * @return the value of the element that was removed
     * @throws UnsupportedOperationException when this operation is not
     *                                       supported
     * @throws IndexOutOfBoundsException     if the specified index is out of range
     */
    public int remove(int index) {
        checkRange(index);
        int oldval = array[index];
        int numtomove = size - index - 1;
        if (numtomove > 0) {
            System.arraycopy(array, index + 1, array, index, numtomove);
        }
        size--;
        return oldval;
    }

    /**
     * Removes from this list all of the elements whose index is between fromIndex,
     * inclusive and toIndex, exclusive. Shifts any succeeding elements to the left (reduces their index).
     */
    public void removeRange(int fromIndex, int toIndex) {
        checkRange(fromIndex);
        checkRange(toIndex);
        if (fromIndex >= toIndex) {
            return;
        }
        int numtomove = size - toIndex;
        if (numtomove > 0) {
            System.arraycopy(array, toIndex, array, fromIndex, numtomove);
        }
        size -= (toIndex - fromIndex);
    }

    /**
     * Replaces the element at the specified position in this list with the specified element.
     *
     * @param index   the index of the element to change
     * @param element the value to be stored at the specified position
     * @return the value previously stored at the specified position
     */
    public int set(int index, int element) {
        checkRange(index);
        int oldval = array[index];
        array[index] = element;
        return oldval;
    }

    /**
     * Appends the specified element to the end of this list.
     */
    public void add(int element) {
        ensureCapacity(size + 1);
        array[size++] = element;
    }

    /**
     * Inserts the specified element at the specified position in this list.
     * Shifts the element currently at that position (if any) and any subsequent
     * elements to the right (adds one to their indices).
     *
     * @param index   the index at which to insert the element
     * @param element the value to insert
     */
    public void add(int index, int element) {
        checkRangeIncludingEndpoint(index);
        ensureCapacity(size + 1);
        int numtomove = size - index;
        System.arraycopy(array, index, array, index + 1, numtomove);
        array[index] = element;
        size++;
    }

    /**
     * Appends all of the elements in the specified array to the end of this list.
     */
    public void addAll(int[] data) {
        int dataLen = data.length;
        if (dataLen == 0) {
            return;
        }
        int newcap = size + (int) (dataLen * 1.1) + 1;
        ensureCapacity(newcap);
        System.arraycopy(data, 0, array, size, dataLen);
        size += dataLen;
    }

    /**
     * Appends all of the elements in the specified array at the specified position in this list.
     */
    public void addAll(int index, int[] data) {
        int dataLen = data.length;
        if (dataLen == 0) {
            return;
        }
        int newcap = size + (int) (dataLen * 1.1) + 1;
        ensureCapacity(newcap);
        System.arraycopy(array, index, array, index + dataLen, size - index);
        System.arraycopy(data, 0, array, index, dataLen);
        size += dataLen;
    }

    /**
     * Removes all of the elements from this list.
     * The list will be empty after this call returns.
     */
    public void clear() {
        size = 0;
    }

    // ---------------------------------------------------------------- search

    /**
     * Returns true if this list contains the specified element.
     */
    public boolean contains(int data) {
        for (int i = 0; i < size; i++) {
            if (array[i] == data) {
                return true;
            }
        }
        return false;
    }


    /**
     * Searches for the first occurrence of the given argument.
     */
    public int indexOf(int data) {
        for (int i = 0; i < size; i++) {
            if (array[i] == data) {
                return i;
            }
        }
        return -1;
    }

    /**
     * Returns the index of the last occurrence of the specified object in this list.
     */
    public int lastIndexOf(int data) {
        for (int i = size - 1; i >= 0; i--) {
            if (array[i] == data) {
                return i;
            }
        }
        return -1;
    }

    /**
     * Tests if this list has no elements.
     */
    public boolean isEmpty() {
        return size == 0;
    }


    // ---------------------------------------------------------------- capacity

    /**
     * Increases the capacity of this ArrayList instance, if necessary,
     * to ensure that it can hold at least the number of elements specified by
     * the minimum capacity argument.
     */
    public void ensureCapacity(int mincap) {
        if (mincap > array.length) {
            int newcap = ((array.length * 3) >> 1) + 1;
            int[] olddata = array;
            array = new int[newcap < mincap ? mincap : newcap];
            System.arraycopy(olddata, 0, array, 0, size);
        }
    }

    /**
     * Trims the capacity of this instance to be the list's current size.
     * An application can use this operation to minimize the storage of some instance.
     */
    public void trimToSize() {
        if (size < array.length) {
            int[] olddata = array;
            array = new int[size];
            System.arraycopy(olddata, 0, array, 0, size);
        }
    }

    // ---------------------------------------------------------------- checks

    private void checkRange(int index) {
        if (index < 0 || index >= size) {
            throw new IndexOutOfBoundsException();
        }
    }

    private void checkRangeIncludingEndpoint(int index) {
        if (index < 0 || index > size) {
            throw new IndexOutOfBoundsException();
        }
    }

}