Package com.carrotsearch.hppc
Class ObjectArrayList<KType>
- java.lang.Object
-
- com.carrotsearch.hppc.ObjectArrayList<KType>
-
- All Implemented Interfaces:
ObjectCollection<KType>
,ObjectContainer<KType>
,ObjectIndexedContainer<KType>
,Preallocable
,java.lang.Cloneable
,java.lang.Iterable<ObjectCursor<KType>>
,java.util.RandomAccess
- Direct Known Subclasses:
ObjectStack
@Generated(date="2021-05-28T03:45:41+0000", value="KTypeArrayList.java") public class ObjectArrayList<KType> extends java.lang.Object implements ObjectIndexedContainer<KType>, Preallocable, java.lang.Cloneable
An array-backed list of Objects.
-
-
Field Summary
Fields Modifier and Type Field Description java.lang.Object[]
buffer
Internal array for storing the list.int
elementsCount
Current number of elements stored inbuffer
.static java.lang.Object[]
EMPTY_ARRAY
An immutable empty buffer (array).protected ArraySizingStrategy
resizer
Buffer resizing strategy.
-
Constructor Summary
Constructors Constructor 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.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(KType e1)
Adds an element to the end of this container (the last index is incremented by one).void
add(KType... elements)
Vararg-signature method for adding elements at the end of the list.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(ObjectContainer<? extends KType> container)
Adds all elements from another container.int
addAll(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)
Adds all elements from another iterable.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 storeexpectedAdditions
.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 anotherObjectIndexedContainer
.boolean
equals(java.lang.Object obj)
Returnstrue
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 ObjectProcedure<? super KType>>
TforEach(T procedure)
Applies aprocedure
to all container elements.<T extends ObjectProcedure<? super KType>>
TforEach(T procedure, int fromIndex, int toIndex)
Appliesprocedure
to a slice of the list,fromIndex
, inclusive, totoIndex
, exclusive.static <KType> ObjectArrayList<KType>
from(KType... elements)
Create a list from a variable number of arguments or an array ofObject
.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 forsize() == 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(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 returnstrue
.int
removeAll(KType e1)
Removes all occurrences ofe
from this collection.int
removeFirst(KType e1)
Removes the first element that equalse1
, returning its deleted position or-1
if the element was not found.int
removeLast(KType e1)
Removes the last element that equalse1
, 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 betweenfromIndex
, inclusive, andtoIndex
, 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 toObjectCollection.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.-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.carrotsearch.hppc.ObjectCollection
removeAll, retainAll, retainAll
-
Methods inherited from interface com.carrotsearch.hppc.ObjectContainer
toArray
-
-
-
-
Field Detail
-
EMPTY_ARRAY
public static final java.lang.Object[] EMPTY_ARRAY
An immutable empty buffer (array).
-
buffer
public java.lang.Object[] buffer
Internal array for storing the list. The array may be larger than the current size (size()
).
-
elementsCount
public int elementsCount
Current number of elements stored inbuffer
.
-
resizer
protected final ArraySizingStrategy resizer
Buffer resizing strategy.
-
-
Constructor Detail
-
ObjectArrayList
public ObjectArrayList()
New instance with sane defaults.
-
ObjectArrayList
public ObjectArrayList(int expectedElements)
New instance with sane defaults.- Parameters:
expectedElements
- The expected number of elements guaranteed not to cause buffer expansion (inclusive).
-
ObjectArrayList
public ObjectArrayList(int expectedElements, ArraySizingStrategy resizer)
New instance with sane defaults.- Parameters:
expectedElements
- The expected number of elements guaranteed not to cause buffer expansion (inclusive).resizer
- Underlying buffer sizing strategy.
-
ObjectArrayList
public ObjectArrayList(ObjectContainer<? extends KType> container)
Creates a new list from the elements of another container in its iteration order.
-
-
Method Detail
-
add
public void add(KType e1)
Adds an element to the end of this container (the last index is incremented by one).- Specified by:
add
in interfaceObjectIndexedContainer<KType>
-
add
public void add(KType e1, KType e2)
Appends two elements at the end of the list. To add more than two elements, useadd
(vararg-version) or access the buffer directly (tight loop).
-
add
public void add(KType[] elements, int start, int length)
Add all elements from a range of given array to the list.
-
add
@SafeVarargs public final void add(KType... elements)
Vararg-signature method for adding elements at the end of the list.This method is handy, but costly if used in tight loops (anonymous array passing)
-
addAll
public int addAll(ObjectContainer<? extends KType> container)
Adds all elements from another container.
-
addAll
public int addAll(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)
Adds all elements from another iterable.
-
insert
public void insert(int index, KType e1)
Inserts the specified element at the specified position in this list.- Specified by:
insert
in interfaceObjectIndexedContainer<KType>
- Parameters:
index
- The index at which the element should be inserted, shifting any existing and subsequent elements to the right.
-
get
public KType get(int index)
- Specified by:
get
in interfaceObjectIndexedContainer<KType>
- Returns:
- Returns the element at index
index
from the list.
-
set
public KType set(int index, KType e1)
Replaces the element at the specified position in this list with the specified element.- Specified by:
set
in interfaceObjectIndexedContainer<KType>
- Returns:
- Returns the previous value in the list.
-
remove
public KType remove(int index)
Removes the element at the specified position in this container and returns it.- Specified by:
remove
in interfaceObjectIndexedContainer<KType>
- See Also:
ObjectIndexedContainer.removeFirst(KType)
,ObjectIndexedContainer.removeLast(KType)
,ObjectCollection.removeAll(KType)
-
removeRange
public void removeRange(int fromIndex, int toIndex)
Removes from this container all of the elements with indexes betweenfromIndex
, inclusive, andtoIndex
, exclusive.- Specified by:
removeRange
in interfaceObjectIndexedContainer<KType>
-
removeFirst
public int removeFirst(KType e1)
Removes the first element that equalse1
, returning its deleted position or-1
if the element was not found.- Specified by:
removeFirst
in interfaceObjectIndexedContainer<KType>
-
removeLast
public int removeLast(KType e1)
Removes the last element that equalse1
, returning its deleted position or-1
if the element was not found.- Specified by:
removeLast
in interfaceObjectIndexedContainer<KType>
-
removeAll
public int removeAll(KType e1)
Removes all occurrences ofe
from this collection.- Specified by:
removeAll
in interfaceObjectCollection<KType>
- Parameters:
e1
- Element to be removed from this collection, if present.- Returns:
- The number of removed elements as a result of this call.
-
contains
public boolean contains(KType e1)
Lookup a given element in the container. This operation has no speed guarantees (may be linear with respect to the size of this container).- Specified by:
contains
in interfaceObjectContainer<KType>
- Returns:
- Returns
true
if this container has an element equal toe
.
-
indexOf
public 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.- Specified by:
indexOf
in interfaceObjectIndexedContainer<KType>
-
lastIndexOf
public 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.- Specified by:
lastIndexOf
in interfaceObjectIndexedContainer<KType>
-
isEmpty
public boolean isEmpty()
Shortcut forsize() == 0
.- Specified by:
isEmpty
in interfaceObjectContainer<KType>
-
ensureCapacity
public void ensureCapacity(int expectedElements)
Ensure this container can hold at least the given number of elements without resizing its buffers.- Specified by:
ensureCapacity
in interfacePreallocable
- Parameters:
expectedElements
- The total number of elements, inclusive.
-
ensureBufferSpace
protected void ensureBufferSpace(int expectedAdditions)
Ensures the internal buffer has enough free slots to storeexpectedAdditions
. Increases internal buffer size if needed.
-
resize
public void resize(int newSize)
Truncate or expand the list to the new size. If the list is truncated, the buffer will not be reallocated (usetrimToSize()
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 ornull
values).
-
size
public int size()
Return the current number of elements in this container. The time for calculating the container's size may takeO(n)
time, although implementing classes should try to maintain the current size and return in constant time.- Specified by:
size
in interfaceObjectContainer<KType>
-
trimToSize
public void trimToSize()
Trim the internal buffer to the current size.
-
clear
public void clear()
Sets the number of stored elements to zero. Releases and initializes the internal storage array to default values. To clear the list without cleaning the buffer, simply set theelementsCount
field to zero.- Specified by:
clear
in interfaceObjectCollection<KType>
- See Also:
ObjectCollection.release()
-
release
public void release()
Sets the number of stored elements to zero and releases the internal storage array.- Specified by:
release
in interfaceObjectCollection<KType>
- See Also:
ObjectCollection.clear()
-
toArray
public java.lang.Object[] toArray()
Default implementation of copying to an array.The returned array is sized to match exactly the number of elements of the stack.
- Specified by:
toArray
in interfaceObjectContainer<KType>
-
clone
public ObjectArrayList<KType> clone()
Clone this object. The returned clone will reuse the same hash function and array resizing strategy.- Overrides:
clone
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
Returnstrue
only if the other object is an instance of the same class and with the same elements. Equality comparison is performed with this object'sequals(Object, Object)
method.- Overrides:
equals
in classjava.lang.Object
-
equalElements
protected boolean equalElements(ObjectArrayList<?> other)
Compare index-aligned elements against anotherObjectIndexedContainer
. Equality comparison is performed with this object'sequals(Object, Object)
method.
-
iterator
public java.util.Iterator<ObjectCursor<KType>> iterator()
Returns an iterator to a cursor traversing the collection. The order of traversal is not defined. More than one cursor may be active at a time. The behavior of iterators is undefined if structural changes are made to the underlying collection.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); }
- Specified by:
iterator
in interfacejava.lang.Iterable<KType>
- Specified by:
iterator
in interfaceObjectContainer<KType>
-
forEach
public <T extends ObjectProcedure<? super KType>> T forEach(T procedure)
Applies aprocedure
to all container elements. Returns the argument (any subclass ofObjectProcedure
. 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;
- Specified by:
forEach
in interfaceObjectContainer<KType>
-
forEach
public <T extends ObjectProcedure<? super KType>> T forEach(T procedure, int fromIndex, int toIndex)
Appliesprocedure
to a slice of the list,fromIndex
, inclusive, totoIndex
, exclusive.
-
removeAll
public int removeAll(ObjectPredicate<? super KType> predicate)
Removes all elements in this collection for which the given predicate returnstrue
.- Specified by:
removeAll
in interfaceObjectCollection<KType>
- Returns:
- Returns the number of removed elements.
-
forEach
public <T extends ObjectPredicate<? super KType>> T forEach(T predicate)
Applies apredicate
to container elements as long, as the predicate returnstrue
. The iteration is interrupted otherwise.- Specified by:
forEach
in interfaceObjectContainer<KType>
-
forEach
public <T extends ObjectPredicate<? super KType>> T forEach(T predicate, int fromIndex, int toIndex)
Appliespredicate
to a slice of the list,fromIndex
, inclusive, totoIndex
, exclusive, or until predicate returnsfalse
.
-
from
@SafeVarargs public static <KType> ObjectArrayList<KType> from(KType... elements)
Create a list from a variable number of arguments or an array ofObject
. The elements are copied from the argument to the internal buffer.
-
removeAll
public int removeAll(ObjectLookupContainer<? super KType> c)
Default implementation uses a predicate for removal.- Specified by:
removeAll
in interfaceObjectCollection<KType>
- Returns:
- Returns the number of removed elements.
-
retainAll
public int retainAll(ObjectLookupContainer<? super KType> c)
Default implementation uses a predicate for retaining.- Specified by:
retainAll
in interfaceObjectCollection<KType>
- Returns:
- Returns the number of removed elements.
-
retainAll
public int retainAll(ObjectPredicate<? super KType> predicate)
Default implementation redirects toObjectCollection.removeAll(ObjectPredicate)
and negates the predicate.- Specified by:
retainAll
in interfaceObjectCollection<KType>
- Returns:
- Returns the number of removed elements.
-
toArray
public <T> T[] toArray(java.lang.Class<T> componentClass)
Description copied from interface:ObjectContainer
Copies all elements of this container to a dynamically created array of the given component type.- Specified by:
toArray
in interfaceObjectContainer<KType>
-
toString
public java.lang.String toString()
Convert the contents of this container to a human-friendly string.- Overrides:
toString
in classjava.lang.Object
-
equals
protected boolean equals(java.lang.Object v1, java.lang.Object v2)
-
-