public class IntArrayList extends AbstractIntList implements java.util.RandomAccess, java.lang.Cloneable, java.io.Serializable
This class implements a lightweight, fast, open, optimized,
reuse-oriented version of array-based lists. Instances of this class
represent a list with an array that is enlarged as needed when new entries
are created (by doubling its current length), but is
never made smaller (even on a clear()
). A family of
trimming methods lets you control the size of the
backing array; this is particularly useful if you reuse instances of this class.
Range checks are equivalent to those of java.util
's classes, but
they are delayed as much as possible. The backing array is exposed by the
elements()
method.
This class implements the bulk methods removeElements()
,
addElements()
and getElements()
using
high-performance system calls (e.g., System.arraycopy()
instead of
expensive loops.
ArrayList
,
Serialized FormAbstractIntList.IntSubList
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_INITIAL_CAPACITY
The initial default capacity of an array list.
|
Constructor and Description |
---|
IntArrayList()
Creates a new array list with
DEFAULT_INITIAL_CAPACITY capacity. |
IntArrayList(java.util.Collection<? extends java.lang.Integer> c)
Creates a new array list and fills it with a given collection.
|
IntArrayList(int capacity)
Creates a new array list with given capacity.
|
IntArrayList(int[] a)
Creates a new array list and fills it with the elements of a given array.
|
IntArrayList(int[] a,
int offset,
int length)
Creates a new array list and fills it with the elements of a given array.
|
IntArrayList(IntCollection c)
Creates a new array list and fills it with a given type-specific collection.
|
IntArrayList(IntIterator i)
Creates a new array list and fills it with the elements returned by a type-specific iterator..
|
IntArrayList(IntList l)
Creates a new array list and fills it with a given type-specific list.
|
IntArrayList(java.util.Iterator<? extends java.lang.Integer> i)
Creates a new array list and fills it with the elements returned by an iterator..
|
Modifier and Type | Method and Description |
---|---|
boolean |
add(int k) |
void |
add(int index,
int k) |
boolean |
addAll(int index,
IntCollection c)
Delegates to a more generic method.
|
boolean |
addAll(int index,
IntList l)
Delegates to a more generic method.
|
void |
addElements(int index,
int[] a,
int offset,
int length)
Adds elements to this type-specific list using optimized system calls.
|
void |
clear() |
IntArrayList |
clone() |
int |
compareTo(IntArrayList l)
Compares this array list to another array list.
|
int[] |
elements()
Returns the backing array of this list.
|
void |
ensureCapacity(int capacity)
Ensures that this array list can contain the given number of entries without resizing.
|
boolean |
equals(IntArrayList l)
Compares this type-specific array list to another one.
|
void |
getElements(int from,
int[] a,
int offset,
int length)
Copies element of this type-specific list into the given array using optimized system calls.
|
int |
getInt(int index) |
int |
indexOf(int k) |
boolean |
isEmpty()
Checks whether the stack is empty.
|
int |
lastIndexOf(int k) |
IntListIterator |
listIterator(int index)
Returns a type-specific list iterator on the list starting at a given index.
|
boolean |
rem(int k)
Note that this method should be called
remove() , but the clash
with the similarly named index-based method in the List interface
forces us to use a distinguished name. |
void |
removeElements(int from,
int to)
Removes elements of this type-specific list using optimized system calls.
|
int |
removeInt(int index) |
int |
set(int index,
int k) |
int |
size() |
void |
size(int size)
Sets the size of this list.
|
int[] |
toIntArray(int[] a)
Returns a primitive type array containing the items of this collection.
|
void |
trim()
Trims this array list so that the capacity is equal to the size.
|
void |
trim(int n)
Trims the backing array if it is too large.
|
static IntArrayList |
wrap(int[] a)
Wraps a given array into an array list.
|
static IntArrayList |
wrap(int[] a,
int length)
Wraps a given array into an array list of given size.
|
add, addAll, addAll, addAll, addAll, addElements, compareTo, contains, equals, get, hashCode, indexOf, intListIterator, intListIterator, intSubList, iterator, lastIndexOf, listIterator, peek, peekInt, pop, popInt, push, push, remove, remove, set, subList, top, topInt, toString
add, contains, containsAll, containsAll, intIterator, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toIntArray
add, contains, containsAll, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray
containsAll, intIterator, removeAll, retainAll, toArray, toArray, toIntArray
public static final int DEFAULT_INITIAL_CAPACITY
public IntArrayList(int capacity)
capacity
- the initial capacity of the array list (may be 0).public IntArrayList()
DEFAULT_INITIAL_CAPACITY
capacity.public IntArrayList(java.util.Collection<? extends java.lang.Integer> c)
c
- a collection that will be used to fill the array list.public IntArrayList(IntCollection c)
c
- a type-specific collection that will be used to fill the array list.public IntArrayList(IntList l)
l
- a type-specific list that will be used to fill the array list.public IntArrayList(int[] a)
a
- an array whose elements will be used to fill the array list.public IntArrayList(int[] a, int offset, int length)
a
- an array whose elements will be used to fill the array list.offset
- the first element to use.length
- the number of elements to use.public IntArrayList(java.util.Iterator<? extends java.lang.Integer> i)
i
- an iterator whose returned elements will fill the array list.public IntArrayList(IntIterator i)
i
- a type-specific iterator whose returned elements will fill the array list.public int[] elements()
public static IntArrayList wrap(int[] a, int length)
a
- an array to wrap.length
- the length of the resulting array list.public static IntArrayList wrap(int[] a)
a
- an array to wrap.public void ensureCapacity(int capacity)
capacity
- the new minimum capacity for this array list.public void add(int index, int k)
add
in interface IntList
add
in class AbstractIntList
List.add(int,Object)
public boolean add(int k)
add
in interface IntCollection
add
in interface IntList
add
in class AbstractIntList
Collection.add(Object)
public int getInt(int index)
public int indexOf(int k)
indexOf
in interface IntList
indexOf
in class AbstractIntList
List.indexOf(Object)
public int lastIndexOf(int k)
lastIndexOf
in interface IntList
lastIndexOf
in class AbstractIntList
List.lastIndexOf(Object)
public int removeInt(int index)
removeInt
in interface IntList
removeInt
in class AbstractIntList
List.remove(int)
public boolean rem(int k)
IntCollection
remove()
, but the clash
with the similarly named index-based method in the List
interface
forces us to use a distinguished name. For simplicity, the set interfaces reinstates
remove()
.rem
in interface IntCollection
rem
in class AbstractIntList
Collection.remove(Object)
public int set(int index, int k)
set
in interface IntList
set
in class AbstractIntList
List.set(int,Object)
public void clear()
clear
in interface java.util.Collection<java.lang.Integer>
clear
in interface java.util.List<java.lang.Integer>
clear
in class java.util.AbstractCollection<java.lang.Integer>
public int size()
size
in interface java.util.Collection<java.lang.Integer>
size
in interface java.util.List<java.lang.Integer>
size
in class java.util.AbstractCollection<java.lang.Integer>
public void size(int size)
IntList
If the specified size is smaller than the current size, the last elements are
discarded. Otherwise, they are filled with 0/null
/false
.
size
in interface IntList
size
in class AbstractIntList
size
- the new size.public boolean isEmpty()
Stack
isEmpty
in interface Stack<java.lang.Integer>
isEmpty
in interface java.util.Collection<java.lang.Integer>
isEmpty
in interface java.util.List<java.lang.Integer>
isEmpty
in class AbstractIntCollection
public void trim()
ArrayList.trimToSize()
public void trim(int n)
n
, this method does nothing. Otherwise, it trims the
array length to the maximum between n
and size()
.
This method is useful when reusing lists. Clearing a list leaves the array length untouched. If you are reusing a list many times, you can call this method with a typical size to avoid keeping around a very large array just because of a few large transient lists.
n
- the threshold for the trimming.public void getElements(int from, int[] a, int offset, int length)
getElements
in interface IntList
getElements
in class AbstractIntList
from
- the start index (inclusive).a
- the destination array.offset
- the offset into the destination array where to store the first element copied.length
- the number of elements to be copied.public void removeElements(int from, int to)
removeElements
in interface IntList
removeElements
in class AbstractIntList
from
- the start index (inclusive).to
- the end index (exclusive).public void addElements(int index, int[] a, int offset, int length)
addElements
in interface IntList
addElements
in class AbstractIntList
index
- the index at which to add elements.a
- the array containing the elements.offset
- the offset of the first element to add.length
- the number of elements to add.public int[] toIntArray(int[] a)
IntCollection
Note that, contrarily to Collection.toArray(Object[])
, this
methods just writes all elements of this collection: no special
value will be added after the last one.
toIntArray
in interface IntCollection
toIntArray
in class AbstractIntCollection
a
- if this array is big enough, it will be used to store this collection.Collection.toArray(Object[])
public boolean addAll(int index, IntCollection c)
AbstractIntList
addAll
in interface IntList
addAll
in class AbstractIntList
List.add(int,Object)
public boolean addAll(int index, IntList l)
AbstractIntList
addAll
in interface IntList
addAll
in class AbstractIntList
List.add(int,Object)
public IntListIterator listIterator(int index)
IntList
listIterator
in interface IntList
listIterator
in interface java.util.List<java.lang.Integer>
listIterator
in class AbstractIntList
List.listIterator(int)
public IntArrayList clone()
clone
in class java.lang.Object
public boolean equals(IntArrayList l)
This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
l
- a type-specific array list.public int compareTo(IntArrayList l)
This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
l
- an array list.