jsimple.util

Class ArrayList<E>

java.lang.Object

jsimple.lang.Iterable<E>

jsimple.util.Collection<E>

jsimple.util.List<E>

jsimple.util.ArrayList<E>

All Implemented Interfaces:

java.lang.Iterable<E>

public final class ArrayList<E>
extends List<E>

ArrayList is an implementation of List, backed by an array. All optional operations adding, removing, and replacing are supported. The elements can be any objects.

Changes from the java.util version:

Does not support clone; use constructor taking a Collection argument instead (which is more flexible and type safe)

Field Summary

Fields

Modifier and Type	Field and Description
protected int	modCount A counter for changes to the list.

Constructor Summary

Constructors

Constructor and Description
ArrayList() Constructs a new instance of ArrayList with ten capacity.
ArrayList(Collection<E> collection) Constructs a new instance of ArrayList containing the elements of the specified collection.
ArrayList(E... args) Constructs an ArrayList, with the specified initial members.
ArrayList(int capacity) Constructs a new instance of ArrayList with the specified capacity.

Method Summary

Modifier and Type	Method and Description
boolean	add(E object) Adds the specified object at the end of this ArrayList.
void	add(int location, E object) Inserts the specified object into this ArrayList at the specified location.
boolean	addAll(Collection<? extends E> collection) Adds the objects in the specified collection to this ArrayList.
boolean	addAll(int location, Collection<? extends E> collection) Inserts the objects in the specified collection at the specified location in this List.
void	clear() Removes all elements from this ArrayList, leaving it empty.
boolean	contains(E object) Searches this ArrayList for the specified object.
void	ensureCapacity(int minimumCapacity) Ensures that after this operation the ArrayList can hold the specified number of elements without further growing.
E	get(int location) Returns the element at the specified location in this list.
int	indexOf(E object) Searches this List for the specified object and returns the index of the first occurrence.
boolean	isEmpty() Returns if this Collection contains no elements.
Iterator<E>	iterator() Returns an iterator on the elements of this list.
int	lastIndexOf(E object) Searches this List for the specified object and returns the index of the last occurrence.
boolean	remove(E object) Removes one instance of the specified object from this Collection if one is contained (optional).
E	remove(int location) Removes the object at the specified location from this list.
E	set(int location, E object) Replaces the element at the specified location in this ArrayList with the specified object.
int	size() Returns the number of elements in this ArrayList.
void	sortInPlace(Comparator<E> comparator)
java.lang.Object[]	toArray() Returns a new array containing all elements contained in this ArrayList.
void	toArray(E[] contents) Returns an array containing all elements contained in this ArrayList.
void	trimToSize() Sets the capacity of this ArrayList to be the same as the current size.

Methods inherited from class jsimple.util.List

equals, hashCode

Methods inherited from class jsimple.util.Collection

containsAll, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

modCount

protected transient int modCount

A counter for changes to the list.

Constructor Detail

ArrayList

public ArrayList()

Constructs a new instance of ArrayList with ten capacity.

ArrayList

public ArrayList(int capacity)

Constructs a new instance of ArrayList with the specified capacity.

Parameters:

capacity - the initial capacity of this ArrayList.

ArrayList

public ArrayList(Collection<E> collection)

Constructs a new instance of ArrayList containing the elements of the specified collection. The initial size of the ArrayList will be 10% larger than the size of the specified collection.

Changes from the java.util version: The constructor there supported covariance, taking a Collection<? extends E> argument where the collection can be of a subclass of E. This constructor only allows collections of exact type E, but you can use the addAll method instead if you really need to copy a collection of a subclass.

Parameters:

collection - the collection of elements to add

ArrayList

public ArrayList(E... args)

Constructs an ArrayList, with the specified initial members. Changes from the java.util version: The constructor is new, added as a convenience method to easily create initialized lists.

Parameters:

args - elements to add initially to the list

Method Detail

add

public void add(int location,
                E object)

Inserts the specified object into this ArrayList at the specified location. The object is inserted before any previous element at the specified location. If the location is equal to the size of this ArrayList, the object is added at the end.

Overrides:

add in class List<E>

Parameters:

location - the index at which to insert the object.

object - the object to add.

Throws:

java.lang.IndexOutOfBoundsException - when location < 0 || > size()

add

public boolean add(E object)

Adds the specified object at the end of this ArrayList.

Overrides:

add in class List<E>

Parameters:

object - the object to add.

Returns:

always true

addAll

public boolean addAll(int location,
                      Collection<? extends E> collection)

Inserts the objects in the specified collection at the specified location in this List. The objects are added in the order they are returned from the collection's iterator.

Overrides:

addAll in class List<E>

Parameters:

location - the index at which to insert.

collection - the collection of objects.

Returns:

true if this ArrayList is modified, false otherwise.

Throws:

java.lang.IndexOutOfBoundsException - when location < 0 || > size()

addAll

public boolean addAll(Collection<? extends E> collection)

Adds the objects in the specified collection to this ArrayList.

Overrides:

addAll in class Collection<E>

Parameters:

collection - the collection of objects.

Returns:

true if this ArrayList is modified, false otherwise.

clear

public void clear()

Removes all elements from this ArrayList, leaving it empty.

Overrides:

clear in class Collection<E>

See Also:

isEmpty(), size()

contains

public boolean contains(E object)

Searches this ArrayList for the specified object.

Overrides:

contains in class Collection<E>

Parameters:

object - the object to search for.

Returns:

true if object is an element of this ArrayList, false otherwise

ensureCapacity

public void ensureCapacity(int minimumCapacity)

Ensures that after this operation the ArrayList can hold the specified number of elements without further growing.

Parameters:

minimumCapacity - the minimum capacity asked for.

get

public E get(int location)

Description copied from class: List

Returns the element at the specified location in this list.

Specified by:

get in class List<E>

Parameters:

location - the index of the element to return.

Returns:

the element at the specified index.

indexOf

public int indexOf(E object)

Description copied from class: List

Searches this List for the specified object and returns the index of the first occurrence.

Specified by:

indexOf in class List<E>

Parameters:

object - the object to search for.

Returns:

the index of the first occurrence of the object or -1 if the object was not found.

isEmpty

public boolean isEmpty()

Description copied from class: Collection

Returns if this Collection contains no elements.

The default implementation tests whether size returns 0.

Overrides:

isEmpty in class Collection<E>

Returns:

true if this Collection has no elements, false otherwise.

See Also:

Collection.size()

lastIndexOf

public int lastIndexOf(E object)

Description copied from class: List

Searches this List for the specified object and returns the index of the last occurrence.

Specified by:

lastIndexOf in class List<E>

Parameters:

object - the object to search for.

Returns:

the index of the last occurrence of the object, or -1 if the object was not found.

iterator

public Iterator<E> iterator()

Returns an iterator on the elements of this list. The elements are iterated in the same order as they occur in the list.

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in class Collection<E>

Returns:

an iterator on the elements of this list.

See Also:

Iterator

remove

public E remove(int location)

Removes the object at the specified location from this list.

Specified by:

remove in class List<E>

Parameters:

location - the index of the object to remove.

Returns:

the removed object.

Throws:

java.lang.IndexOutOfBoundsException - when location < 0 || >= size()

remove

public boolean remove(E object)

Description copied from class: Collection

Removes one instance of the specified object from this Collection if one is contained (optional). The element elem that is removed complies with (object==null ? elem==null : object.equals(elem).

The default implementation iterates over this Collection and tests for each element e returned by the iterator, whether e is equal to the given object. If object != null then this test is performed using object.equals(e), otherwise using object == null. If an element equal to the given object is found, then the remove method is called on the iterator and true is returned, false otherwise. If the iterator does not support removing elements, an UnsupportedOperationException is thrown.

Overrides:

remove in class Collection<E>

Parameters:

object - the object to remove.

Returns:

true if this Collection is modified, false otherwise.

set

public E set(int location,
             E object)

Replaces the element at the specified location in this ArrayList with the specified object.

Specified by:

set in class List<E>

Parameters:

location - the index at which to put the specified object.

object - the object to add.

Returns:

the previous element at the index.

Throws:

java.lang.IndexOutOfBoundsException - when location < 0 || >= size()

size

public int size()

Returns the number of elements in this ArrayList.

Specified by:

size in class Collection<E>

Returns:

the number of elements in this ArrayList.

toArray

public java.lang.Object[] toArray()

Returns a new array containing all elements contained in this ArrayList.

Overrides:

toArray in class Collection<E>

Returns:

an array of the elements from this ArrayList

toArray

public void toArray(E[] contents)

Returns an array containing all elements contained in this ArrayList. If the specified array is large enough to hold the elements, the specified array is used, otherwise an array of the same type is created. If the specified array is used and is larger than this ArrayList, the array element following the collection elements is set to null.

Overrides:

toArray in class Collection<E>

Parameters:

contents - the array.

Throws:

java.lang.ArrayStoreException - when the type of an element in this ArrayList cannot be stored in the type of the specified array.

sortInPlace

public void sortInPlace(Comparator<E> comparator)

trimToSize

public void trimToSize()

Sets the capacity of this ArrayList to be the same as the current size.

See Also:

size()