Top Description Fields Constructors Methods
sun.awt.util

public Class IdentityArrayList<E>

extends AbstractList<E>
implements List<E>, RandomAccess
Class Inheritance
All Implemented Interfaces
java.util.RandomAccess, java.util.List, java.util.SequencedCollection, java.util.Collection, java.lang.Iterable
Imports
java.util.AbstractList, .Arrays, .Collection, .ConcurrentModificationException, .List, .RandomAccess

Resizable-array implementation of the List interface. Implements all optional list operations, and permits all elements, including null. In addition to implementing the List interface, this class provides methods to manipulate the size of the array that is used internally to store the list. (This class is roughly equivalent to Vector, except that it is unsynchronized.)

The size, isEmpty, get, set, iterator, and listIterator operations run in constant time. The add operation runs in amortized constant time, that is, adding n elements requires O(n) time. All of the other operations run in linear time (roughly speaking). The constant factor is low compared to that for the LinkedList implementation.

Each IdentityArrayList instance has a capacity. The capacity is the size of the array used to store the elements in the list. It is always at least as large as the list size. As elements are added to an IdentityArrayList, its capacity grows automatically. The details of the growth policy are not specified beyond the fact that adding an element has constant amortized time cost.

An application can increase the capacity of an IdentityArrayList instance before adding a large number of elements using the ensureCapacity operation. This may reduce the amount of incremental reallocation.

Note that this implementation is not synchronized. If multiple threads access an IdentityArrayList instance concurrently, and at least one of the threads modifies the list structurally, it must be synchronized externally. (A structural modification is any operation that adds or deletes one or more elements, or explicitly resizes the backing array; merely setting the value of an element is not a structural modification.) This is typically accomplished by synchronizing on some object that naturally encapsulates the list. If no such object exists, the list should be "wrapped" using the Collections.synchronizedList method. This is best done at creation time, to prevent accidental unsynchronized access to the list:

  List list = Collections.synchronizedList(new IdentityArrayList(...));

The iterators returned by this class's iterator and listIterator methods are fail-fast: if the list is structurally modified at any time after the iterator is created, in any way except through the iterator's own remove or add methods, the iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.

Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.

Field Summary

Modifier and TypeField and Description
private transient Object[]
elementData

The array buffer into which the elements of the IdentityArrayList are stored.

private int
size

The size of the IdentityArrayList (the number of elements it contains).

Inherited from java.util.AbstractList:
modCount

Constructor Summary

AccessConstructor and Description
public
IdentityArrayList(int
the initial capacity of the list
initialCapacity
)

Constructs an empty list with the specified initial capacity.

public
IdentityArrayList()

Constructs an empty list with an initial capacity of ten.

public
IdentityArrayList(Collection<? extends E>
the collection whose elements are to be placed into this list
c
)

Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true (as specified by Collection#add)
add
(E
element to be appended to this list
e
)

Overrides java.util.AbstractList.add.

Implements java.util.List.add, java.util.Collection.add.

Appends the specified element to the end of this list.
public void
add(int
index at which the specified element is to be inserted
index
,
E
element to be inserted
element
)

Overrides java.util.AbstractList.add.

Implements java.util.List.add.

Inserts the specified element at the specified position in this list.
public boolean

Returns:

true if this list changed as a result of the call
addAll
(Collection<? extends E>
collection containing elements to be added to this list
c
)

Overrides java.util.AbstractCollection.addAll.

Implements java.util.List.addAll, java.util.Collection.addAll.

Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's Iterator.
public boolean

Returns:

true if this list changed as a result of the call
addAll
(int
index at which to insert the first element from the specified collection
index
,
Collection<? extends E>
collection containing elements to be added to this list
c
)

Overrides java.util.AbstractList.addAll.

Implements java.util.List.addAll.

Inserts all of the elements in the specified collection into this list, starting at the specified position.
public void
clear()

Overrides java.util.AbstractList.clear.

Implements java.util.List.clear, java.util.Collection.clear.

Removes all of the elements from this list.
public boolean

Returns:

true if this list contains the specified element
contains
(Object
element whose presence in this list is to be tested
o
)

Overrides java.util.AbstractCollection.contains.

Implements java.util.List.contains, java.util.Collection.contains.

Returns true if this list contains the specified element.
public void
ensureCapacity(int
the desired minimum capacity
minCapacity
)

Increases the capacity of this IdentityArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.

private void
fastRemove(int index)

public E

Returns:

the element at the specified position in this list
get
(int
index of the element to return
index
)

Implements abstract java.util.AbstractList.get.

Implements java.util.List.get.

Returns the element at the specified position in this list.
public int

Returns:

the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element
indexOf
(Object
element to search for
o
)

Overrides java.util.AbstractList.indexOf.

Implements java.util.List.indexOf.

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
public boolean

Returns:

true if this list contains no elements
isEmpty
()

Overrides java.util.AbstractCollection.isEmpty.

Implements java.util.List.isEmpty, java.util.Collection.isEmpty.

Returns true if this list contains no elements.
public int

Returns:

the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element
lastIndexOf
(Object
element to search for
o
)

Overrides java.util.AbstractList.lastIndexOf.

Implements java.util.List.lastIndexOf.

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
private String
outOfBoundsMsg(int index)

Hides java.util.AbstractList.outOfBoundsMsg.

Constructs an IndexOutOfBoundsException detail message.
private void
rangeCheck(int index)

Checks if the given index is in range.

private void
rangeCheckForAdd(int index)

Hides java.util.AbstractList.rangeCheckForAdd.

A version of rangeCheck used by add and addAll.
public E

Returns:

the element that was removed from the list
remove
(int
the index of the element to be removed
index
)

Overrides java.util.AbstractList.remove.

Implements java.util.List.remove.

Removes the element at the specified position in this list.
public boolean

Returns:

true if this list contained the specified element
remove
(Object
element to be removed from this list, if present
o
)

Overrides java.util.AbstractCollection.remove.

Implements java.util.List.remove, java.util.Collection.remove.

Removes the first occurrence of the specified element from this list, if it is present.
protected void
removeRange(int
index of first element to be removed
fromIndex
,
int
index after last element to be removed
toIndex
)

Overrides java.util.AbstractList.removeRange.

Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.
public E

Returns:

the element previously at the specified position
set
(int
index of the element to replace
index
,
E
element to be stored at the specified position
element
)

Overrides java.util.AbstractList.set.

Implements java.util.List.set.

Replaces the element at the specified position in this list with the specified element.
public int

Returns:

the number of elements in this list
size
()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.List.size, java.util.Collection.size.

Returns the number of elements in this list.
public Object[]

Returns:

an array containing all of the elements in this list in proper sequence
toArray
()

Overrides java.util.AbstractCollection.toArray.

Implements java.util.List.toArray, java.util.Collection.toArray.

Returns an array containing all of the elements in this list in proper sequence (from first to last element).
public <T> T[]

Returns:

an array containing the elements of the list
toArray
(T[]
the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
a
)

Overrides java.util.AbstractCollection.toArray.

Implements java.util.List.toArray, java.util.Collection.toArray.

Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.
public void
trimToSize()

Trims the capacity of this IdentityArrayList instance to be the list's current size.

Inherited from java.util.AbstractList:
equalshashCodeiteratorlistIteratorlistIteratorsubList

Field Detail

elementDataback to summary
private transient Object[] elementData

The array buffer into which the elements of the IdentityArrayList are stored. The capacity of the IdentityArrayList is the length of this array buffer.

sizeback to summary
private int size

The size of the IdentityArrayList (the number of elements it contains).

Constructor Detail

IdentityArrayListback to summary
public IdentityArrayList(int initialCapacity)

Constructs an empty list with the specified initial capacity.

Parameters
initialCapacity:int

the initial capacity of the list

Exceptions
IllegalArgumentException:
if the specified initial capacity is negative
IdentityArrayListback to summary
public IdentityArrayList()

Constructs an empty list with an initial capacity of ten.

IdentityArrayListback to summary
public IdentityArrayList(Collection<? extends E> c)

Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.

Parameters
c:Collection<? extends E>

the collection whose elements are to be placed into this list

Exceptions
NullPointerException:
if the specified collection is null

Method Detail

addback to summary
public boolean add(E e)

Overrides java.util.AbstractList.add.

Implements java.util.List.add, java.util.Collection.add.

Appends the specified element to the end of this list.

Parameters
e:E

element to be appended to this list

Returns:boolean

true (as specified by Collection#add)

addback to summary
public void add(int index, E element)

Overrides java.util.AbstractList.add.

Implements java.util.List.add.

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).

Parameters
index:int

index at which the specified element is to be inserted

element:E

element to be inserted

Exceptions
IndexOutOfBoundsException:
if the index is out of range (index < 0 || index > size())
addAllback to summary
public boolean addAll(Collection<? extends E> c)

Overrides java.util.AbstractCollection.addAll.

Implements java.util.List.addAll, java.util.Collection.addAll.

Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's Iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this list, and this list is nonempty.)

Parameters
c:Collection<? extends E>

collection containing elements to be added to this list

Returns:boolean

true if this list changed as a result of the call

Exceptions
NullPointerException:
if the specified collection is null
addAllback to summary
public boolean addAll(int index, Collection<? extends E> c)

Overrides java.util.AbstractList.addAll.

Implements java.util.List.addAll.

Inserts all of the elements in the specified collection into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the list in the order that they are returned by the specified collection's iterator.

Parameters
index:int

index at which to insert the first element from the specified collection

c:Collection<? extends E>

collection containing elements to be added to this list

Returns:boolean

true if this list changed as a result of the call

Exceptions
IndexOutOfBoundsException:
if the index is out of range (index < 0 || index > size())
NullPointerException:
if the specified collection is null
clearback to summary
public void clear()

Overrides java.util.AbstractList.clear.

Implements java.util.List.clear, java.util.Collection.clear.

Removes all of the elements from this list. The list will be empty after this call returns.

containsback to summary
public boolean contains(Object o)

Overrides java.util.AbstractCollection.contains.

Implements java.util.List.contains, java.util.Collection.contains.

Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that o == e.

Parameters
o:Object

element whose presence in this list is to be tested

Returns:boolean

true if this list contains the specified element

ensureCapacityback to summary
public void ensureCapacity(int minCapacity)

Increases the capacity of this IdentityArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.

Parameters
minCapacity:int

the desired minimum capacity

fastRemoveback to summary
private void fastRemove(int index)
getback to summary
public E get(int index)

Implements abstract java.util.AbstractList.get.

Implements java.util.List.get.

Returns the element at the specified position in this list.

Parameters
index:int

index of the element to return

Returns:E

the element at the specified position in this list

Exceptions
IndexOutOfBoundsException:
if the index is out of range (index < 0 || index >= size())
indexOfback to summary
public int indexOf(Object o)

Overrides java.util.AbstractList.indexOf.

Implements java.util.List.indexOf.

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that get(i) == o, or -1 if there is no such index.

Parameters
o:Object

element to search for

Returns:int

the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element

isEmptyback to summary
public boolean isEmpty()

Overrides java.util.AbstractCollection.isEmpty.

Implements java.util.List.isEmpty, java.util.Collection.isEmpty.

Returns true if this list contains no elements.

Returns:boolean

true if this list contains no elements

lastIndexOfback to summary
public int lastIndexOf(Object o)

Overrides java.util.AbstractList.lastIndexOf.

Implements java.util.List.lastIndexOf.

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that get(i) == o, or -1 if there is no such index.

Parameters
o:Object

element to search for

Returns:int

the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element

outOfBoundsMsgback to summary
private String outOfBoundsMsg(int index)

Hides java.util.AbstractList.outOfBoundsMsg.

Constructs an IndexOutOfBoundsException detail message. Of the many possible refactorings of the error handling code, this "outlining" performs best with both server and client VMs.

rangeCheckback to summary
private void rangeCheck(int index)

Checks if the given index is in range. If not, throws an appropriate runtime exception. This method does *not* check if the index is negative: It is always used immediately prior to an array access, which throws an ArrayIndexOutOfBoundsException if index is negative.

rangeCheckForAddback to summary
private void rangeCheckForAdd(int index)

Hides java.util.AbstractList.rangeCheckForAdd.

A version of rangeCheck used by add and addAll.

removeback to summary
public E remove(int index)

Overrides java.util.AbstractList.remove.

Implements java.util.List.remove.

Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).

Parameters
index:int

the index of the element to be removed

Returns:E

the element that was removed from the list

Exceptions
IndexOutOfBoundsException:
if the index is out of range (index < 0 || index >= size())
removeback to summary
public boolean remove(Object o)

Overrides java.util.AbstractCollection.remove.

Implements java.util.List.remove, java.util.Collection.remove.

Removes the first occurrence of the specified element from this list, if it is present. If this list does not contain the element, the list is unchanged. More formally, removes the element with the lowest index i such that get(i) == o (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).

Parameters
o:Object

element to be removed from this list, if present

Returns:boolean

true if this list contained the specified element

removeRangeback to summary
protected void removeRange(int fromIndex, int toIndex)

Overrides java.util.AbstractList.removeRange.

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). This call shortens the list by (toIndex - fromIndex) elements. (If toIndex==fromIndex, this operation has no effect.)

Parameters
fromIndex:int

index of first element to be removed

toIndex:int

index after last element to be removed

Exceptions
IndexOutOfBoundsException:
if fromIndex or toIndex out of range (fromIndex < 0 || fromIndex >= size() || toIndex > size() || toIndex < fromIndex)
setback to summary
public E set(int index, E element)

Overrides java.util.AbstractList.set.

Implements java.util.List.set.

Replaces the element at the specified position in this list with the specified element.

Parameters
index:int

index of the element to replace

element:E

element to be stored at the specified position

Returns:E

the element previously at the specified position

Exceptions
IndexOutOfBoundsException:
if the index is out of range (index < 0 || index >= size())
sizeback to summary
public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.List.size, java.util.Collection.size.

Returns the number of elements in this list.

Returns:int

the number of elements in this list

toArrayback to summary
public Object[] toArray()

Overrides java.util.AbstractCollection.toArray.

Implements java.util.List.toArray, java.util.Collection.toArray.

Returns an array containing all of the elements in this list in proper sequence (from first to last element).

The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Returns:Object[]

an array containing all of the elements in this list in proper sequence

toArrayback to summary
public <T> T[] toArray(T[] a)

Overrides java.util.AbstractCollection.toArray.

Implements java.util.List.toArray, java.util.Collection.toArray.

Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list.

If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the collection is set to null. (This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.)

Parameters
<T>

Doc from java.util.Collection.toArray. the component type of the array to contain the collection

a:T[]

the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:T[]

an array containing the elements of the list

Annotations
@SuppressWarnings:unchecked
Exceptions
ArrayStoreException:
if the runtime type of the specified array is not a supertype of the runtime type of every element in this list
NullPointerException:
if the specified array is null
trimToSizeback to summary
public void trimToSize()

Trims the capacity of this IdentityArrayList instance to be the list's current size. An application can use this operation to minimize the storage of an IdentityArrayList instance.