@Generated(date="2015-05-05T11:00:03+0200", value="KTypeArrayList.java") public class ObjectArrayList<KType> extends java.lang.Object implements ObjectIndexedContainer<KType>, Preallocable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
java.lang.Object[] |
buffer
Internal array for storing the list.
|
int |
elementsCount
Current number of elements stored in
buffer . |
static java.lang.Object[] |
EMPTY_ARRAY
An immutable empty buffer (array).
|
protected ArraySizingStrategy |
resizer
Buffer resizing strategy.
|
Constructor and Description |
---|
ObjectArrayList()
New instance with sane defaults.
|
ObjectArrayList(int expectedElements)
New instance with sane defaults.
|
ObjectArrayList(int expectedElements,
ArraySizingStrategy resizer)
New instance with sane defaults.
|
ObjectArrayList(ObjectContainer<? extends KType> container)
Creates a new list from the elements of another container in its
iteration order.
|
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.
|
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.
|
protected void |
ensureBufferSpace(int expectedAdditions)
Ensures the internal buffer has enough free slots to store
expectedAdditions . |
void |
ensureCapacity(int expectedElements)
Ensure this container can hold at least the given number of elements
without resizing its buffers.
|
protected boolean |
equalElements(ObjectArrayList<?> other)
Compare index-aligned elements against another
ObjectIndexedContainer . |
boolean |
equals(java.lang.Object obj)
Returns
true only if the other object is an instance of
the same class and with the same elements. |
protected boolean |
equals(java.lang.Object v1,
java.lang.Object v2) |
<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 . |
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.
|
boolean |
isEmpty()
Shortcut for
size() == 0 . |
java.util.Iterator<ObjectCursor<KType>> |
iterator()
Returns an iterator to a cursor traversing the collection.
|
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.
|
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 container and returns
it.
|
int |
removeAll(KType e1)
Removes all occurrences of
e from this collection. |
int |
removeAll(ObjectLookupContainer<? super KType> c)
Default implementation uses a predicate for removal.
|
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 container all of the elements with indexes between
fromIndex , inclusive, and toIndex , exclusive. |
void |
resize(int newSize)
Truncate or expand the list to the new size.
|
int |
retainAll(ObjectLookupContainer<? super KType> c)
Default implementation uses a predicate for retaining.
|
int |
retainAll(ObjectPredicate<? super KType> predicate)
Default implementation redirects to
ObjectCollection.removeAll(ObjectPredicate) and
negates the predicate. |
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.
|
java.lang.Object[] |
toArray()
Default implementation of copying to an array.
|
<T> T[] |
toArray(java.lang.Class<T> componentClass)
Copies all elements of this container to a dynamically created array of the
given component type.
|
java.lang.String |
toString()
Convert the contents of this container to a human-friendly string.
|
void |
trimToSize()
Trim the internal buffer to the current size.
|
finalize, getClass, notify, notifyAll, wait, wait, wait
removeAll, retainAll, retainAll
toArray
public static final java.lang.Object[] EMPTY_ARRAY
public java.lang.Object[] buffer
size()
).public int elementsCount
buffer
.protected final ArraySizingStrategy resizer
public ObjectArrayList()
public ObjectArrayList(int expectedElements)
expectedElements
- The expected number of elements guaranteed not to cause buffer
expansion (inclusive).public ObjectArrayList(int expectedElements, ArraySizingStrategy resizer)
expectedElements
- The expected number of elements guaranteed not to cause buffer
expansion (inclusive).resizer
- Underlying buffer sizing strategy.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)
@SafeVarargs public final void add(KType... elements)
This method is handy, but costly if used in tight loops (anonymous array passing)
public int addAll(ObjectContainer<? extends KType> container)
public int addAll(java.lang.Iterable<? extends ObjectCursor<? extends KType>> 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.public KType get(int index)
get
in interface ObjectIndexedContainer<KType>
index
from the list.public KType set(int index, KType e1)
set
in interface ObjectIndexedContainer<KType>
public KType remove(int index)
remove
in interface ObjectIndexedContainer<KType>
ObjectIndexedContainer.removeFirst(KType)
,
ObjectIndexedContainer.removeLast(KType)
,
ObjectCollection.removeAll(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 boolean isEmpty()
size() == 0
.isEmpty
in interface ObjectContainer<KType>
public void ensureCapacity(int expectedElements)
ensureCapacity
in interface Preallocable
expectedElements
- The total number of elements, inclusive.protected void ensureBufferSpace(int expectedAdditions)
expectedAdditions
. Increases internal buffer size if needed.public void resize(int newSize)
trimToSize()
if you need a
truncated buffer), but the truncated values will be reset to the default
value (zero). 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 void trimToSize()
public void clear()
elementsCount
field to zero.clear
in interface ObjectCollection<KType>
ObjectCollection.release()
public void release()
release
in interface ObjectCollection<KType>
ObjectCollection.clear()
public java.lang.Object[] toArray()
The returned array is sized to match exactly the number of elements of the stack.
toArray
in interface ObjectContainer<KType>
public ObjectArrayList<KType> clone()
clone
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
true
only if the other object is an instance of
the same class and with the same elements.
Equality comparison is performed with this object's equals(Object, Object)
method.equals
in class java.lang.Object
protected boolean equalElements(ObjectArrayList<?> other)
ObjectIndexedContainer
.
Equality comparison is performed with this object's equals(Object, Object)
method.public java.util.Iterator<ObjectCursor<KType>> iterator()
The iterator is implemented as a cursor and it returns the same cursor
instance on every call to Iterator.next()
(to avoid boxing of
primitive types). To read the current list's value (or index in the list)
use the cursor's public fields. An example is shown below.
for (ObjectCursor<Object> c : container) { System.out.println("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.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
.@SafeVarargs public static <KType> ObjectArrayList<KType> from(KType... elements)
Object
.
The elements are copied from the argument to the internal buffer.public int removeAll(ObjectLookupContainer<? super KType> c)
removeAll
in interface ObjectCollection<KType>
public int retainAll(ObjectLookupContainer<? super KType> c)
retainAll
in interface ObjectCollection<KType>
public int retainAll(ObjectPredicate<? super KType> predicate)
ObjectCollection.removeAll(ObjectPredicate)
and
negates the predicate.retainAll
in interface ObjectCollection<KType>
public <T> T[] toArray(java.lang.Class<T> componentClass)
ObjectContainer
toArray
in interface ObjectContainer<KType>
public java.lang.String toString()
toString
in class java.lang.Object
protected boolean equals(java.lang.Object v1, java.lang.Object v2)
Copyright © 2015 Carrot Search s.c.. All Rights Reserved.