@Generated(date="2017-07-11T19:16:25+0200",
value="KTypeArrayList.java")
public class ObjectArrayList<KType>
extends AbstractObjectCollection<KType>
implements ObjectIndexedContainer<KType>, java.lang.Cloneable
ArraySizingStrategy
and may be expensive if they move around really large chunks of memory.
It also has some dedicated methods to easily push, pop, and discard elements
from the end of the array, emulating so a java.util.Stack.
(see "Stack-emulating methods)
A brief comparison of the API against the Java Collections framework:
| java.util.ArrayList | ObjectArrayList |
|---|---|
| add | add |
| add(index,v) | insert(index,v) |
| get | get |
| removeRange, removeElementAt | removeRange, remove |
| remove(Object) | removeFirst, removeLast, removeAll |
| clear | clear, release |
| size | size |
| ensureCapacity | ensureCapacity, resize |
| indexOf | indexOf |
| lastIndexOf | lastIndexOf |
| trimToSize | trimtoSize |
| Object[] toArray() | Object[] toArray() |
| iterator | cursor over values |
| Modifier and Type | Class and Description |
|---|---|
class |
ObjectArrayList.ValueIterator
An iterator implementation for
iterator(). |
| Modifier and Type | Field and Description |
|---|---|
java.lang.Object[] |
buffer
Internal array for storing the list.
|
protected int |
elementsCount
Current number of elements stored in
buffer. |
protected ArraySizingStrategy |
resizer
Buffer resizing strategy.
|
protected IteratorPool<ObjectCursor<KType>,ObjectArrayList.ValueIterator> |
valueIteratorPool
internal pool of ValueIterator (must be created in constructor)
|
containsNegateTestPredicate, containsTestPredicate, negatePredicate, testContainer, testPredicate| Constructor and Description |
|---|
ObjectArrayList()
Default constructor: Create with default sizing strategy and initial capacity for storing
Containers.DEFAULT_EXPECTED_ELEMENTS elements. |
ObjectArrayList(int initialCapacity)
Create with default sizing strategy and the given initial capacity.
|
ObjectArrayList(int initialCapacity,
ArraySizingStrategy resizer)
Create with a custom buffer resizing strategy.
|
ObjectArrayList(ObjectContainer<? extends KType> container)
Creates a new list from elements of another container.
|
| Modifier and Type | Method and Description |
|---|---|
void |
add(KType... elements)
Vararg-signature method for adding elements at the end of the list.
|
void |
add(KType e1)
Adds an element to the end of this container (the last index is incremented by one).
|
void |
add(KType[] elements,
int start,
int length)
Add all elements from a range of given array to the list.
|
void |
add(KType e1,
KType e2)
Appends two elements at the end of the list.
|
int |
addAll(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)
Adds all elements from another iterable.
|
int |
addAll(ObjectContainer<? extends KType> container)
Adds all elements from another container.
|
int |
capacity()
Return the maximum number of elements this container is guaranteed to hold without reallocating.
|
void |
clear()
Sets the number of stored elements to zero.
|
ObjectArrayList<KType> |
clone()
Clone this object.
|
boolean |
contains(KType e1)
Lookup a given element in the container.
|
void |
discardLast()
Stack emulating method: Discard the last element of the array.
|
void |
discardLast(int count)
Stack emulating method: Discard an arbitrary number of elements from the end of the array.
|
protected void |
ensureBufferSpace(int expectedAdditions)
Ensures the internal buffer has enough free slots to store
expectedAdditions. |
void |
ensureCapacity(int minCapacity)
Increases the capacity of this instance, if necessary, to ensure
that it can hold at least the number of elements specified by
the minimum capacity argument.
|
boolean |
equals(java.lang.Object obj) |
<T extends ObjectPredicate<? super KType>> |
forEach(T predicate)
Applies a
predicate to container elements, as long as the predicate
returns true. |
<T extends ObjectProcedure<? super KType>> |
forEach(T procedure)
Applies a
procedure to all container elements. |
<T extends ObjectPredicate<? super KType>> |
forEach(T predicate,
int fromIndex,
int toIndex)
Applies
predicate to a slice of the list,
fromIndex, inclusive, to toIndex,
exclusive, or until predicate returns false. |
<T extends ObjectProcedure<? super KType>> |
forEach(T procedure,
int fromIndex,
int toIndex)
Applies
procedure to a slice of the list,
fromIndex, inclusive, to toIndex, exclusive. |
static <KType> ObjectArrayList<KType> |
from(KType... elements)
Create a list from a variable number of arguments or an array of
Object. |
static <KType> ObjectArrayList<KType> |
from(ObjectContainer<KType> container)
Create a list from elements of another container.
|
KType |
get(int index) |
int |
hashCode() |
int |
indexOf(KType e1)
Returns the index of the first occurrence of the specified element in this list,
or -1 if this list does not contain the element.
|
void |
insert(int index,
KType e1)
Inserts the specified element at the specified position in this list.
|
ObjectArrayList.ValueIterator |
iterator()
Returns an iterator over the values of this list.
|
int |
lastIndexOf(KType e1)
Returns the index of the last occurrence of the specified element in this list,
or -1 if this list does not contain the element.
|
static <KType> ObjectArrayList<KType> |
newInstance()
Returns a new object of this class with no need to declare generic type (shortcut
instead of using a constructor).
|
static <KType> ObjectArrayList<KType> |
newInstance(int initialCapacity)
Returns a new object of this class with no need to declare generic type (shortcut
instead of using a constructor).
|
KType |
peekLast()
Stack emulating method: Peek at the last element on the array.
|
KType |
popLast()
Stack emulating method: Discard the last element of the array, and return it.
|
int |
pushAllLast(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)
Stack emulating method: Pushes all elements from another iterable to the end of the array,
synonym of
addAll(Iterable) |
int |
pushAllLast(ObjectContainer<? extends KType> container)
Stack emulating method: Pushes all elements from another container at the end of the array,
synonym of
addAll(ObjectContainer) |
void |
pushLast(KType... elements)
Stack emulating method: Vararg-signature method for pushing elements at the end of the array.
|
void |
pushLast(KType e1)
Stack emulating method: Adds one Object at the end of the array,
equivalent of
add(Object) |
void |
pushLast(KType[] elements,
int start,
int len)
Stack emulating method: Add a range of array elements at the end of array,
synonym of
add(Object[], int, int) |
void |
pushLast(KType e1,
KType e2)
Stack emulating method: Adds two Objects at the end of the array,
synonym of
add(Object, Object) |
void |
pushLast(KType e1,
KType e2,
KType e3)
Stack emulating method: Adds three Objects at the end of the array
|
void |
pushLast(KType e1,
KType e2,
KType e3,
KType e4)
Stack emulating method: Adds four Objects at the end of the array
|
void |
release()
Sets the number of stored elements to zero and releases the internal storage array.
|
KType |
remove(int index)
Removes the element at the specified position in this list and returns it.
|
int |
removeAll(KType e1)
Removes all occurrences of
e from this collection. |
int |
removeAll(ObjectPredicate<? super KType> predicate)
Removes all elements in this collection for which the
given predicate returns
true. |
int |
removeFirst(KType e1)
Removes the first element that equals
e1, returning its
deleted position or -1 if the element was not found. |
int |
removeLast(KType e1)
Removes the last element that equals
e1, returning its
deleted position or -1 if the element was not found. |
void |
removeRange(int fromIndex,
int toIndex)
Removes from this list all of the elements whose index is between
fromIndex, inclusive, and toIndex, exclusive. |
void |
resize(int newSize)
Truncate or expand the list to the new size.
|
KType |
set(int index,
KType e1)
Replaces the element at the specified position in this list
with the specified element.
|
int |
size()
Return the current number of elements in this container.
|
void |
sort()
In-place sort the whole list by natural ordering (smaller first)
This sort is NOT stable.
|
void |
sort(java.util.Comparator<? super KType> comp)
In-place sort the whole list
using a
Comparator *
This sort is NOT stable. |
void |
sort(int beginIndex,
int endIndex)
In-place sort the list from [beginIndex, endIndex[
by natural ordering (smaller first)
|
void |
sort(int beginIndex,
int endIndex,
java.util.Comparator<? super KType> comp)
In-place sort the list from [beginIndex, endIndex[
using a
Comparator *
This sort is NOT stable. |
KType[] |
toArray(KType[] target)
Default implementation for:
Copies all elements of this container to an existing array of the same type.
|
void |
trimToSize()
Trim the internal buffer to the current size.
|
isEmpty, removeAll, retainAll, retainAll, toArray, toArray, toStringfinalize, getClass, notify, notifyAll, wait, wait, waitremoveAll, retainAll, retainAllisEmpty, toArray, toArraypublic java.lang.Object[] buffer
size()).
Direct list iteration: iterate buffer[i] for i in [0; size()[
protected int elementsCount
buffer.protected final ArraySizingStrategy resizer
protected final IteratorPool<ObjectCursor<KType>,ObjectArrayList.ValueIterator> valueIteratorPool
public ObjectArrayList()
Containers.DEFAULT_EXPECTED_ELEMENTS elements.BoundedProportionalArraySizingStrategypublic ObjectArrayList(int initialCapacity)
BoundedProportionalArraySizingStrategypublic ObjectArrayList(int initialCapacity,
ArraySizingStrategy resizer)
public ObjectArrayList(ObjectContainer<? extends KType> container)
public void add(KType e1)
add in interface ObjectIndexedContainer<KType>public void add(KType e1, KType e2)
add (vararg-version) or access the buffer directly (tight
loop).public void add(KType[] elements, int start, int length)
elements - start - length - public void add(KType... elements)
This method is handy, but costly if used in tight loops (anonymous array passing)
elements - public int addAll(ObjectContainer<? extends KType> container)
container - public int addAll(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)
iterable - public void insert(int index,
KType e1)
insert in interface ObjectIndexedContainer<KType>index - The index at which the element should be inserted, shifting
any existing and subsequent elements to the right.
Precondition : index must be valid !public KType get(int index)
get in interface ObjectIndexedContainer<KType>index from the list.
Precondition : index must be valid !public KType set(int index, KType e1)
set in interface ObjectIndexedContainer<KType>public KType remove(int index)
Careful. Do not confuse this method with the overridden signature in
Java Collections (List.remove(Object)). Use: ObjectCollection.removeAll(KType),
ObjectIndexedContainer.removeFirst(KType) or ObjectIndexedContainer.removeLast(KType) depending
on the actual need.
remove in interface ObjectIndexedContainer<KType>public void removeRange(int fromIndex,
int toIndex)
fromIndex, inclusive, and toIndex, exclusive.removeRange in interface ObjectIndexedContainer<KType>public int removeFirst(KType e1)
e1, returning its
deleted position or -1 if the element was not found.removeFirst in interface ObjectIndexedContainer<KType>public int removeLast(KType e1)
e1, returning its
deleted position or -1 if the element was not found.removeLast in interface ObjectIndexedContainer<KType>public int removeAll(KType e1)
e from this collection.removeAll in interface ObjectCollection<KType>e1 - Element to be removed from this collection, if present.public boolean contains(KType e1)
contains in interface ObjectContainer<KType>true if this container has an element
equal to e.public int indexOf(KType e1)
indexOf in interface ObjectIndexedContainer<KType>public int lastIndexOf(KType e1)
lastIndexOf in interface ObjectIndexedContainer<KType>public void ensureCapacity(int minCapacity)
protected void ensureBufferSpace(int expectedAdditions)
expectedAdditions. Increases internal buffer size if needed.public void resize(int newSize)
trimToSize() if you need a truncated buffer).
If the list is expanded, the elements beyond the current size are initialized with JVM-defaults
(zero or null values).public int size()
O(n) time, although implementing classes
should try to maintain the current size and return in constant time.size in interface ObjectContainer<KType>public int capacity()
O(n) time.capacity in interface ObjectContainer<KType>public void trimToSize()
public void clear()
clear in interface ObjectCollection<KType>public void release()
public KType[] toArray(KType[] target)
toArray in interface ObjectContainer<KType>toArray in class AbstractObjectCollection<KType>target - The target array must be large enough to hold all elements, i.e >= ObjectContainer.size().public ObjectArrayList<KType> clone()
clone in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Objectpublic ObjectArrayList.ValueIterator iterator()
Iterator.next() (to avoid boxing of primitive types). To
read the current value, or index in the list's buffer (which also matches index as in get(int)), use the cursor's public
fields. An example is shown below.
for (Iteratori = intDeque.descendingIterator(); i.hasNext(); ) { final IntCursor c = i.next(); System.out.println("buffer index=" + c.index + " value=" + c.value); }
iterator in interface ObjectContainer<KType>iterator in interface java.lang.Iterable<ObjectCursor<KType>>public <T extends ObjectProcedure<? super KType>> T forEach(T procedure)
procedure to all container elements. Returns the argument (any
subclass of ObjectProcedure. This lets the caller to call methods of the argument
by chaining the call (even if the argument is an anonymous type) to retrieve computed values,
for example (IntContainer):
int count = container.forEach(new IntProcedure() {
int count; // this is a field declaration in an anonymous class.
public void apply(int value) { count++; }}).count;
forEach in interface ObjectContainer<KType>public <T extends ObjectProcedure<? super KType>> T forEach(T procedure, int fromIndex, int toIndex)
procedure to a slice of the list,
fromIndex, inclusive, to toIndex, exclusive.forEach in interface ObjectIndexedContainer<KType>public int removeAll(ObjectPredicate<? super KType> predicate)
true.removeAll in interface ObjectCollection<KType>public <T extends ObjectPredicate<? super KType>> T forEach(T predicate)
predicate to container elements, as long as the predicate
returns true. The iteration is interrupted otherwise.forEach in interface ObjectContainer<KType>public <T extends ObjectPredicate<? super KType>> T forEach(T predicate, int fromIndex, int toIndex)
predicate to a slice of the list,
fromIndex, inclusive, to toIndex,
exclusive, or until predicate returns false.forEach in interface ObjectIndexedContainer<KType>public static <KType> ObjectArrayList<KType> newInstance()
public static <KType> ObjectArrayList<KType> newInstance(int initialCapacity)
public static <KType> ObjectArrayList<KType> from(KType... elements)
Object.public static <KType> ObjectArrayList<KType> from(ObjectContainer<KType> container)
public void sort(int beginIndex,
int endIndex)
beginIndex - the start index to be sortedendIndex - the end index to be sorted (excluded)
This sort is NOT stable.
java.lang.ClassCastException - if the list contains elements that are not mutually Comparable.public void sort()
This sort is NOT stable.
java.lang.ClassCastException - if the list contains elements that are not mutually Comparable.public void sort(int beginIndex,
int endIndex,
java.util.Comparator<? super KType> comp)
Comparator * This sort is NOT stable.
beginIndex - the start index to be sortedendIndex - the end index to be sorted (excluded)public void sort(java.util.Comparator<? super KType> comp)
Comparator * This sort is NOT stable.
public void pushLast(KType e1)
add(Object)e1 - public void pushLast(KType e1, KType e2)
add(Object, Object)e1 - e2 - public void pushLast(KType e1, KType e2, KType e3)
e1 - e2 - e3 - public void pushLast(KType e1, KType e2, KType e3, KType e4)
e1 - e2 - e3 - e4 - public void pushLast(KType[] elements, int start, int len)
add(Object[], int, int)public final void pushLast(KType... elements)
This method is handy, but costly if used in tight loops (anonymous array passing)
public int pushAllLast(ObjectContainer<? extends KType> container)
addAll(ObjectContainer)public int pushAllLast(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)
addAll(Iterable)iterable - public void discardLast(int count)
count - public void discardLast()
public KType popLast()
public KType peekLast()
Copyright © 2017. All rights reserved.