IntArrayList (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.siox.util.IntArrayList

```
public class IntArrayList
extends Object
```
An ArrayList that uses primitive ints for the key rather than objects to avoid costly usage of Integer wrappers.
For convenience, it also provides methods similar to those of the java.util.Stack.

Version:

1.0

Author:

Lars Knipping

See Also:

ArrayList, Stack

Field Summary

Fields
Modifier and Type Field and Description

protected int modCount
The number of times this list has been structurally modified.

Fields
Modifier and Type	Field and Description
`protected int`	`modCount` The number of times this list has been structurally modified.

Constructor Summary

Constructors
Constructor and Description
`IntArrayList()` Constructs an empty list with an initial capacity of ten.
`IntArrayList(Collection c)` Constructs a list containing the elements of the specified collection, in the order they are given in the array.
`IntArrayList(int initialCapacity)` Constructs an empty list with the specified initial capacity .
`IntArrayList(int[] a)` Constructs a list containing the elements of the specified array, in the order they are given in the array.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(int value)` Appends the specified element to the end of this list.
`void`	`add(int index, int value)` Inserts the specified element at the specified position in this list.
`boolean`	`addAll(Collection c)` Appends all of the elements in the specified collection, in the order that they appear in the array.
`boolean`	`addAll(int[] a)` Appends all of the elements in the specified array, in the order that they appear in the array.
`boolean`	`addAll(int index, Collection c)` Inserts all of the elements in the specified array into this list, starting at the specified position.
`boolean`	`addAll(int index, int[] a)` Inserts all of the elements in the specified array into this list, starting at the specified position.
`void`	`clear()` Removes all of the elements from this list.
`Object`	`clone()` Returns a copy of this IntArrayList instance.
`boolean`	`contains(int value)` Returns true if this list contains the specified element.
`void`	`ensureCapacity(int minCapacity)` Increases the capacity of this IntArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
`boolean`	`equals(Object o)` Compares the specified object with this list for equality.
`int`	`get(int index)` Returns the element at the specified position in this list.
`int`	`hashCode()` Returns the hash code value for this list.
`int`	`indexOf(int value)` Searches for the first occurence of the given argument, testing for equality using the equals method.
`boolean`	`isEmpty()` Tests if this list has no elements.
`Iterator`	`iterator()` Returns an iterator of the elements in this list (in proper sequence).
`int`	`lastIndexOf(int value)` Returns the index of the last occurrence of the specified value in this list.
`ListIterator`	`listIterator()` Returns an iterator over the elements in this list in proper sequence.
`ListIterator`	`listIterator(int index)` Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in the list.
`int`	`peek()` Returns the entry at highest index (stack's top) without removing it.
`int`	`pop()` Removes the entry at highest index (stack's top) returns it.
`int`	`push(int value)` Pushes an entry onto the the end of this list (on top of the stack) and returns it.
`int`	`remove(int index)` Removes the element at the specified position in this list.
`protected void`	`removeRange(int fromIndex, int toIndex)` Removes from this List all of the elements whose index is between fromIndex, inclusive and toIndex, exclusive.
`int`	`search(int value)` Returns the 1-based position where an object is on this stack.
`int`	`set(int index, int value)` Replaces the element at the specified position in this list with the specified element.
`int`	`size()` Returns the number of elements in this list.
`IntArrayList`	`subList(int fromIndex, int toIndex)` Returns a view of the portion of this list between fromIndex, inclusive, and toIndex, exclusive.
`int[]`	`toArray()` Returns an array containing all of the elements in this list in the correct order.
`int[]`	`toArray(int[] a)` Returns an array containing all of the elements in this list in the correct order, using the specified array if it is non-null and large enough.
`void`	`trimToSize()` Trims the capacity of this ArrayList instance to be the list's current size.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - modCount
```
protected transient int modCount
```
    The number of times this list has been structurally modified.
    This field is used by the iterators to check for modifications triggering a ConcurrentModificationException.
- Constructor Detail
  - IntArrayList
```
public IntArrayList(int initialCapacity)
```
    Constructs an empty list with the specified initial capacity .
  - IntArrayList
```
public IntArrayList()
```
    Constructs an empty list with an initial capacity of ten.
  - IntArrayList
```
public IntArrayList(Collection c)
```
    Constructs a list containing the elements of the specified collection, in the order they are given in the array.
    
    Throws:
    
    ClassCastException - if the collection contains objects of other class than Integer
    
    NullPointerException - if the collection contains a null object
  - IntArrayList
```
public IntArrayList(int[] a)
```
    Constructs a list containing the elements of the specified array, in the order they are given in the array.
- Method Detail
  - add
```
public void add(int index,
                int value)
```
    Inserts the specified element at the specified position in this list.
    
    Throws:
    
    IndexOutOfBoundsException - if index out of range (index < 0 || index > size()).
  - add
```
public boolean add(int value)
```
    Appends the specified element to the end of this list.
    
    Returns:
    
    true (as per the general contract of Collection.add).
  - addAll
```
public boolean addAll(int[] a)
```
    Appends all of the elements in the specified array, in the order that they appear in the array.
    
    Returns:
    
    true if the operation changed this list.
  - addAll
```
public boolean addAll(Collection c)
```
    Appends all of the elements in the specified collection, in the order that they appear in the array.
    
    Returns:
    
    true if the operation changed this list.
    
    Throws:
    
    ClassCastException - if the collection contains objects of other class than Integer
    
    NullPointerException - if the collection contains a null object
  - addAll
```
public boolean addAll(int index,
                      Collection c)
```
    Inserts all of the elements in the specified array into this list, starting at the specified position.
    
    Parameters:
    
    index - index at which to insert first element from the array.
    
    c - Collections of Integers with int values to be inserted into this list.
    
    Returns:
    
    true if the operation changed this list.
    
    Throws:
    
    IndexOutOfBoundsException - if index out of range (index
    ClassCastException - if the collection contains objects of other class than Integer
    NullPointerException - if the collection contains a null object < 0 || index > size()).
  - addAll
```
public boolean addAll(int index,
                      int[] a)
```
    Inserts all of the elements in the specified array into this list, starting at the specified position.
    
    Parameters:
    
    index - index at which to insert first element from the array.
    
    a - elements to be inserted into this list.
    
    Returns:
    
    true if the operation changed this list.
    
    Throws:
    
    IndexOutOfBoundsException - if index out of range (index < 0 || index > size()).
  - clear
```
public void clear()
```
    Removes all of the elements from this list.
  - clone
```
public Object clone()
```
    Returns a copy of this IntArrayList instance.
    
    Overrides:
    
    clone in class Object
  - contains
```
public boolean contains(int value)
```
    Returns true if this list contains the specified element.
  - ensureCapacity
```
public void ensureCapacity(int minCapacity)
```
    Increases the capacity of this IntArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
  - equals
```
public boolean equals(Object o)
```
    Compares the specified object with this list for equality.
    
    Overrides:
    
    equals in class Object
  - get
```
public int get(int index)
```
    Returns the element at the specified position in this list.
  - listIterator
```
public ListIterator listIterator()
```
    Returns an iterator over the elements in this list in proper sequence. The ints retuned by the iterator are wrapped into Integer objects.
  - iterator
```
public Iterator iterator()
```
    Returns an iterator of the elements in this list (in proper sequence). The ints retuned by the iterator are wrapped into Integer objects.
  - listIterator
```
public ListIterator listIterator(int index)
```
    Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in the list. The ints retuned by the iterator are wrapped into Integer objects.
  - hashCode
```
public int hashCode()
```
    Returns the hash code value for this list.
    
    Overrides:
    
    hashCode in class Object
  - indexOf
```
public int indexOf(int value)
```
    Searches for the first occurence of the given argument, testing for equality using the equals method.
    
    Returns:
    
    the index of the first occurrence of the argument in this list; returns -1 if the value is not found.
  - isEmpty
```
public boolean isEmpty()
```
    Tests if this list has no elements.
  - lastIndexOf
```
public int lastIndexOf(int value)
```
    Returns the index of the last occurrence of the specified value in this list.
    
    Returns:
    
    the index of the last occurrence of the argument in this list; returns -1 if the value is not found.
  - remove
```
public int remove(int index)
```
    Removes the element at the specified position in this list.
    
    Returns:
    
    the removed value.
    
    Throws:
    
    IndexOutOfBoundsException - if index out of range (index < 0 || index ≥ size()).
  - removeRange
```
protected void removeRange(int fromIndex,
                           int toIndex)
```
    Removes from this List all of the elements whose index is between fromIndex, inclusive and toIndex, exclusive.
    A call with toIndex <= fromIndex has no effect.
    
    Throws:
    
    IndexOutOfBoundsException - if an index out of range.
  - set
```
public int set(int index,
               int value)
```
    Replaces the element at the specified position in this list with the specified element.
    
    Throws:
    
    IndexOutOfBoundsException - if index out of range (index < 0 || index > size()).
  - size
```
public int size()
```
    Returns the number of elements in this list.
  - subList
```
public IntArrayList subList(int fromIndex,
                            int toIndex)
```
    Returns a view of the portion of this list between fromIndex, inclusive, and toIndex, exclusive.
    
    Throws:
    
    IndexOutOfBoundsException - if an index out of range.
  - toArray
```
public int[] toArray()
```
    Returns an array containing all of the elements in this list in the correct order.
  - toArray
```
public int[] toArray(int[] a)
```
    Returns an array containing all of the elements in this list in the correct order, using the specified array if it is non-null and large enough.
  - trimToSize
```
public void trimToSize()
```
    Trims the capacity of this ArrayList instance to be the list's current size.
  - peek
```
public int peek()
```
    Returns the entry at highest index (stack's top) without removing it.
    
    Throws:
    
    EmptyStackException - if this list/stack is empty.
  - pop
```
public int pop()
```
    Removes the entry at highest index (stack's top) returns it.
    
    Throws:
    
    EmptyStackException - if this list/stack is empty.
  - push
```
public int push(int value)
```
    Pushes an entry onto the the end of this list (on top of the stack) and returns it. The method has the same effect as add(value).
  - search
```
public int search(int value)
```
    Returns the 1-based position where an object is on this stack.
    
    Returns:
    
    the 1-based position from the top of the stack where the value is located; the return value -1 indicates that the value is not on the stack.

Class IntArrayList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

modCount

Constructor Detail

IntArrayList

IntArrayList

IntArrayList

IntArrayList

Method Detail

add

add

addAll

addAll

addAll

addAll

clear

clone

contains

ensureCapacity

equals

get

listIterator

iterator

listIterator

hashCode

indexOf

isEmpty

lastIndexOf

remove

removeRange

set

size

subList

toArray

toArray

trimToSize

peek

pop

push

search