jodd.util.collection

Class JoddArrayList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

jodd.util.collection.JoddArrayList<E>

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, java.util.RandomAccess

public class JoddArrayList<E>
extends java.util.AbstractList<E>
implements java.util.RandomAccess, java.lang.Cloneable

Faster drop-in replacement for ArrayList and LinkedList. ArrayList performs slow when elements are added in the middle of the list. Adding element to the first position if slow as the whole buffer has to be moved. LinkedList is slow for random access and always takes more memory then ArrayList.

This implementation gives better performances as it can grow both sides: left and right. Its not circular, like some other list implementations out there, so the implementation can remain rather simple. Moreover, if that make more sense, list will not grow, but data will be moved internally to fill up the gaps.

This implementation can be fine-tuned. There are the following parameters:

• pivotType - pivot splits the list on the left and right side. There are 3 types of pivots, depending how do you expect the list will be populated
• minimalGrowSize - font grow for less then this number.
• maxFreeSpaceBeforeNormalize - if list has at least this much of space, don't grow it, but move the buffer data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JoddArrayList.PIVOT_TYPE Defines pivot point types.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object[]	buffer
protected int	end
protected int	maxFreeSpaceBeforeNormalize
protected int	minimalGrowSize
protected int	pivotIndex
protected JoddArrayList.PIVOT_TYPE	pivotType
protected int	size
protected int	start

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
JoddArrayList() Constructs an empty list with an initial capacity of ten.
JoddArrayList(java.util.Collection<? extends E> collection) Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.
JoddArrayList(E... array) Constructs a list containing the elements of provided array.
JoddArrayList(int initialCapacity) Constructs an empty list with the specified initial capacity.
JoddArrayList(int initialCapacity, JoddArrayList.PIVOT_TYPE pivot_type, int minimalGrowSize, int maxFreeSpaceBeforeNormalize) Constructs fine-tuned list.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E e) Appends the specified element to the end of this list.
void	add(int index, E element) Inserts the specified element at the specified position in this list.
boolean	addAll(java.util.Collection<? extends E> collection) 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.
boolean	addAll(E... array) Appends all elements of given array.
boolean	addAll(int index, java.util.Collection<? extends E> collection) Inserts all of the elements in the specified collection into this list, starting at the specified position.
boolean	addAll(int index, E... array) Inserts all array elements to this list.
boolean	addFirst(E e) Adds the specified element to the beginning of this list.
boolean	addLast(E e) Appends element to the list.
protected boolean	batchRemove(java.util.Collection<?> collection, boolean complement)
void	clear() Removes all of the elements from this list.
java.lang.Object	clone() Returns a shallow copy of this ArrayList instance.
boolean	contains(java.lang.Object o) Returns true if this list contains the specified element.
protected boolean	doAddAll(int index, java.lang.Object[] array)
protected boolean	doAddAll(java.lang.Object[] array)
protected E	doRemove(int index)
protected void	ensureCapacity(int index, int elementsToAdd) Ensures that buffer size will handle addition of elementsToAdd elements on provided index position.
E	get(int index) Returns the element at the specified position in this list.
E	getFirst() Returns the first element in the list.
E	getLast() Returns the last element of the list.
int	indexOf(java.lang.Object o) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
protected void	init(int capacity) Initializes the list.
boolean	isEmpty() Returns true if this list contains no elements.
java.util.Iterator<E>	iterator() Returns an iterator over the elements in this list in proper sequence.
int	lastIndexOf(java.lang.Object o) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
java.util.ListIterator<E>	listIterator() Returns a list iterator over the elements in this list (in proper sequence).
java.util.ListIterator<E>	listIterator(int index) Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
protected void	normalize() Normalizes list by moving the content into ideal position balanced over pivot.
E	remove(int index) Removes the element at the specified position in this list.
boolean	remove(java.lang.Object o) Removes the first occurrence of the specified element from this list, if it is present.
boolean	removeAll(java.util.Collection<?> c) Removes from this list all of its elements that are contained in the specified collection.
E	removeFirst() Removes first element of the list.
E	removeLast() Removes last element of the 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.
boolean	retainAll(java.util.Collection<?> c) Retains only the elements in this list that are contained in the specified collection.
E	set(int index, E element) Replaces the element at the specified position in this list with the specified element.
int	size() Returns the number of elements in this list.
java.lang.Object[]	toArray() Returns an array containing all of the elements in this list in proper sequence (from first to last element).
<T> T[]	toArray(T[] array) 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.
java.lang.String	toString() Returns string representation of this array.
void	trimToSize() Trims the capacity of this ArrayList instance to be the list's current size.

Methods inherited from class java.util.AbstractList

equals, hashCode, subList

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll

Field Detail

buffer

protected java.lang.Object[] buffer

size

protected int size

start

protected int start

end

protected int end

pivotIndex

protected int pivotIndex

pivotType

protected JoddArrayList.PIVOT_TYPE pivotType

minimalGrowSize

protected int minimalGrowSize

maxFreeSpaceBeforeNormalize

protected int maxFreeSpaceBeforeNormalize

Constructor Detail

JoddArrayList

public JoddArrayList(int initialCapacity)

Constructs an empty list with the specified initial capacity.

JoddArrayList

public JoddArrayList(int initialCapacity,
             JoddArrayList.PIVOT_TYPE pivot_type,
             int minimalGrowSize,
             int maxFreeSpaceBeforeNormalize)

Constructs fine-tuned list.

JoddArrayList

public JoddArrayList()

Constructs an empty list with an initial capacity of ten.

JoddArrayList

public JoddArrayList(java.util.Collection<? extends E> collection)

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

JoddArrayList

public JoddArrayList(E... array)

Constructs a list containing the elements of provided array.

Method Detail

init

protected void init(int capacity)

Initializes the list.

trimToSize

public void trimToSize()

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

normalize

protected void normalize()

Normalizes list by moving the content into ideal position balanced over pivot. It is called to prevent growth of the buffer when there is enough empty space.

ensureCapacity

protected void ensureCapacity(int index,
                  int elementsToAdd)

Ensures that buffer size will handle addition of elementsToAdd elements on provided index position.

size

public int size()

Returns the number of elements in this list.

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface java.util.List<E>

Specified by:

size in class java.util.AbstractCollection<E>

isEmpty

public boolean isEmpty()

Returns true if this list contains no elements.

Specified by:

isEmpty in interface java.util.Collection<E>

Specified by:

isEmpty in interface java.util.List<E>

Overrides:

isEmpty in class java.util.AbstractCollection<E>

contains

public boolean contains(java.lang.Object o)

Returns true if this list contains the specified element.

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.List<E>

Overrides:

contains in class java.util.AbstractCollection<E>

indexOf

public int indexOf(java.lang.Object o)

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 (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:

indexOf in interface java.util.List<E>

Overrides:

indexOf in class java.util.AbstractList<E>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

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

Specified by:

lastIndexOf in interface java.util.List<E>

Overrides:

lastIndexOf in class java.util.AbstractList<E>

clone

public java.lang.Object clone()

Returns a shallow copy of this ArrayList instance. (The elements themselves are not copied.)

Overrides:

clone in class java.lang.Object

toArray

public java.lang.Object[] toArray()

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

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.List<E>

Overrides:

toArray in class java.util.AbstractCollection<E>

toArray

public <T> T[] toArray(T[] array)

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.

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.List<E>

Overrides:

toArray in class java.util.AbstractCollection<E>

get

public E get(int index)

Returns the element at the specified position in this list.

Specified by:

get in interface java.util.List<E>

Specified by:

get in class java.util.AbstractList<E>

getFirst

public E getFirst()

Returns the first element in the list.

getLast

public E getLast()

Returns the last element of the list.

set

public E set(int index,
    E element)

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

Specified by:

set in interface java.util.List<E>

Overrides:

set in class java.util.AbstractList<E>

add

public boolean add(E e)

Appends the specified element to the end of this list.

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.List<E>

Overrides:

add in class java.util.AbstractList<E>

addFirst

public boolean addFirst(E e)

Adds the specified element to the beginning of this list.

addLast

public boolean addLast(E e)

Appends element to the list.

add

public void add(int index,
       E element)

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

Specified by:

add in interface java.util.List<E>

Overrides:

add in class java.util.AbstractList<E>

addAll

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

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.

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.List<E>

Overrides:

addAll in class java.util.AbstractCollection<E>

addAll

public boolean addAll(E... array)

Appends all elements of given array.

doAddAll

protected boolean doAddAll(java.lang.Object[] array)

addAll

public boolean addAll(int index,
             java.util.Collection<? extends E> collection)

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. The new elements will appear in the list in the order that they are returned by the specified collection's iterator.

Specified by:

addAll in interface java.util.List<E>

Overrides:

addAll in class java.util.AbstractList<E>

addAll

public boolean addAll(int index,
             E... array)

Inserts all array elements to this list.

doAddAll

protected boolean doAddAll(int index,
               java.lang.Object[] array)

clear

public void clear()

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

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.List<E>

Overrides:

clear in class java.util.AbstractList<E>

removeFirst

public E removeFirst()

Removes first element of the list.

removeLast

public E removeLast()

Removes last element of the list.

remove

public E remove(int index)

Removes the element at the specified position in this list. Shifts any subsequent elements.

Specified by:

remove in interface java.util.List<E>

Overrides:

remove in class java.util.AbstractList<E>

doRemove

protected E doRemove(int index)

remove

public boolean remove(java.lang.Object o)

Removes the first occurrence of the specified element from this list, if it is present.

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.List<E>

Overrides:

remove in class java.util.AbstractCollection<E>

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. Shifts any succeeding elements to the left (reduces their index).

Overrides:

removeRange in class java.util.AbstractList<E>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Removes from this list all of its elements that are contained in the specified collection.

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.List<E>

Overrides:

removeAll in class java.util.AbstractCollection<E>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Retains only the elements in this list that are contained in the specified collection. In other words, removes from this list all of its elements that are not contained in the specified collection.

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.List<E>

Overrides:

retainAll in class java.util.AbstractCollection<E>

batchRemove

protected boolean batchRemove(java.util.Collection<?> collection,
                  boolean complement)

listIterator

public java.util.ListIterator<E> listIterator(int index)

Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.

Specified by:

listIterator in interface java.util.List<E>

Overrides:

listIterator in class java.util.AbstractList<E>

listIterator

public java.util.ListIterator<E> listIterator()

Returns a list iterator over the elements in this list (in proper sequence).

Specified by:

listIterator in interface java.util.List<E>

Overrides:

listIterator in class java.util.AbstractList<E>

See Also:

listIterator(int)

iterator

public java.util.Iterator<E> iterator()

Returns an iterator over the elements in this list in proper sequence.

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in interface java.util.List<E>

Overrides:

iterator in class java.util.AbstractList<E>

toString

public java.lang.String toString()

Returns string representation of this array.

Overrides:

toString in class java.util.AbstractCollection<E>