org.apache.commons.collections.primitives
Class ArrayIntList

java.lang.Object
  extended by org.apache.commons.collections.primitives.AbstractIntCollection
      extended by org.apache.commons.collections.primitives.RandomAccessIntList
          extended by org.apache.commons.collections.primitives.ArrayIntList
All Implemented Interfaces:
Serializable, IntCollection, IntList

public class ArrayIntList
extends RandomAccessIntList
implements IntList, Serializable

An IntList backed by an array of ints. This implementation supports all optional methods.

Since:
Commons Primitives 1.0
Version:
$Revision: 480460 $ $Date: 2006-11-29 09:14:21 +0100 (Wed, 29 Nov 2006) $
Author:
Rodney Waldhoff, Robert Fischer
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.commons.collections.primitives.RandomAccessIntList
RandomAccessIntList.RandomAccessIntListIterator, RandomAccessIntList.RandomAccessIntSubList
 
Constructor Summary
ArrayIntList()
          Construct an empty list with the default initial capacity.
ArrayIntList(int initialCapacity)
          Construct an empty list with the given initial capacity.
ArrayIntList(int[] array)
          Constructs a list by copying the specified array.
ArrayIntList(IntCollection that)
          Constructs a list containing the elements of the given collection, in the order they are returned by that collection's iterator.
 
Method Summary
 void add(int index, int element)
          Inserts the specified element at the specified position (optional operation).
 boolean addAll(IntCollection collection)
          Adds all of the elements in the specified collection to me (optional operation).
 boolean addAll(int index, IntCollection collection)
          Inserts all of the elements in the specified collection into me, at the specified position (optional operation).
 void clear()
          Removes all my elements (optional operation).
 void ensureCapacity(int mincap)
          Increases my capacity, if necessary, to ensure that I can hold at least the number of elements specified by the minimum capacity argument without growing.
 int get(int index)
          Returns the value of the element at the specified position within me.
 int removeElementAt(int index)
          Removes the element at the specified position in (optional operation).
 int set(int index, int element)
          Replaces the element at the specified position in me with the specified element (optional operation).
 int size()
          Returns the number of elements I contain.
 void trimToSize()
          Reduce my capacity, if necessary, to match my current size.
 
Methods inherited from class org.apache.commons.collections.primitives.RandomAccessIntList
add, equals, getModCount, hashCode, incrModCount, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList, toString
 
Methods inherited from class org.apache.commons.collections.primitives.AbstractIntCollection
contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.commons.collections.primitives.IntList
add, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList
 
Methods inherited from interface org.apache.commons.collections.primitives.IntCollection
contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray
 

Constructor Detail

ArrayIntList

public ArrayIntList()
Construct an empty list with the default initial capacity.


ArrayIntList

public ArrayIntList(int initialCapacity)
Construct an empty list with the given initial capacity.

Throws:
IllegalArgumentException - when initialCapacity is negative

ArrayIntList

public ArrayIntList(IntCollection that)
Constructs a list containing the elements of the given collection, in the order they are returned by that collection's iterator.

Parameters:
that - the non-null collection of ints to add
Throws:
NullPointerException - if that is null
See Also:
addAll(org.apache.commons.collections.primitives.IntCollection)

ArrayIntList

public ArrayIntList(int[] array)
Constructs a list by copying the specified array.

Parameters:
array - the array to initialize the collection with
Throws:
NullPointerException - if the array is null
Method Detail

get

public int get(int index)
Description copied from interface: IntList
Returns the value of the element at the specified position within me.

Specified by:
get in interface IntList
Specified by:
get in class RandomAccessIntList
Parameters:
index - the index of the element to return
Returns:
the value of the element at the specified position

size

public int size()
Description copied from interface: IntCollection
Returns the number of elements I contain.

Specified by:
size in interface IntCollection
Specified by:
size in class RandomAccessIntList
Returns:
the number of elements I contain

removeElementAt

public int removeElementAt(int index)
Removes the element at the specified position in (optional operation). Any subsequent elements are shifted to the left, subtracting one from their indices. Returns the element that was removed.

Specified by:
removeElementAt in interface IntList
Overrides:
removeElementAt in class RandomAccessIntList
Parameters:
index - the index of the element to remove
Returns:
the value of the element that was removed
Throws:
UnsupportedOperationException - when this operation is not supported
IndexOutOfBoundsException - if the specified index is out of range

set

public int set(int index,
               int element)
Replaces the element at the specified position in me with the specified element (optional operation).

Specified by:
set in interface IntList
Overrides:
set in class RandomAccessIntList
Parameters:
index - the index of the element to change
element - the value to be stored at the specified position
Returns:
the value previously stored at the specified position
Throws:
UnsupportedOperationException - when this operation is not supported
IndexOutOfBoundsException - if the specified index is out of range

add

public void add(int index,
                int element)
Inserts the specified element at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right, increasing their indices.

Specified by:
add in interface IntList
Overrides:
add in class RandomAccessIntList
Parameters:
index - the index at which to insert the element
element - the value to insert
Throws:
UnsupportedOperationException - when this operation is not supported
IllegalArgumentException - if some aspect of the specified element prevents it from being added to me
IndexOutOfBoundsException - if the specified index is out of range

clear

public void clear()
Description copied from interface: IntCollection
Removes all my elements (optional operation). I will be empty after this method successfully returns.

Specified by:
clear in interface IntCollection
Overrides:
clear in class AbstractIntCollection

addAll

public boolean addAll(IntCollection collection)
Description copied from interface: IntCollection
Adds all of the elements in the specified collection to me (optional operation).

Specified by:
addAll in interface IntCollection
Overrides:
addAll in class AbstractIntCollection
Parameters:
collection - the collection of elements whose presence within me is to be ensured
Returns:
true iff I changed as a result of this call

addAll

public boolean addAll(int index,
                      IntCollection collection)
Description copied from interface: IntList
Inserts all of the elements in the specified collection into me, at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right, increasing their indices. The new elements will appear in the order that they are returned by the given collection's iterator.

Specified by:
addAll in interface IntList
Overrides:
addAll in class RandomAccessIntList
Parameters:
index - the index at which to insert the first element from the specified collection
collection - the IntCollection of elements to add
Returns:
true iff I changed as a result of this call

ensureCapacity

public void ensureCapacity(int mincap)
Increases my capacity, if necessary, to ensure that I can hold at least the number of elements specified by the minimum capacity argument without growing.


trimToSize

public void trimToSize()
Reduce my capacity, if necessary, to match my current size.



Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.