Module com.carrotsearch.hppc
Package com.carrotsearch.hppc

Class ObjectArrayList<KType>

java.lang.Object
com.carrotsearch.hppc.ObjectArrayList<KType>
All Implemented Interfaces:
Accountable, ObjectCollection<KType>, ObjectContainer<KType>, ObjectIndexedContainer<KType>, Preallocable, Cloneable, Iterable<ObjectCursor<KType>>, RandomAccess
Direct Known Subclasses:
ObjectStack
@Generated(date="2024-06-04T15:20:17+0200", value="KTypeArrayList.java") public class ObjectArrayList<KType> extends Object implements ObjectIndexedContainer<KType>, Preallocable, Cloneable, Accountable
An array-backed list of Objects.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    Object[]
    buffer
    Internal array for storing the list.
    int
    elementsCount
    Current number of elements stored in buffer.
    static final Object[]
    EMPTY_ARRAY
    An immutable empty buffer (array).
    protected final 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

    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).
    final 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(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 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(Object obj)
    Returns true only if the other object is an instance of the same class and with the same elements.
    protected boolean
    equals(Object v1, Object v2)
     
    <T extends ObjectProcedure<? super KType>>
    T
    forEach(T procedure)
    Applies a procedure to all container elements.
    <T extends ObjectProcedure<? super KType>>
    T
    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.
    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.
    long
    ramBytesAllocated()
    Allocated memory estimation
    long
    ramBytesUsed()
    Bytes that is actually been used
    void
    release()
    Sets the number of stored elements to zero and releases the internal storage array.
    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
    removeAll(KType e1)
    Removes all occurrences of e from this collection.
    KType
    removeAt(int index)
    Removes the element at the specified position in this container and returns it.
    boolean
    removeElement(KType e1)
    Removes the first element that equals e1, returning whether an element has been removed.
    int
    removeFirst(KType e1)
    Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.
    KType
    removeLast()
    Removes and returns the last element of this container.
    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.
    ObjectIndexedContainer<KType>
    reverse()
    Reverses the elements in this container and returns this container.
    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.
    ObjectIndexedContainer<KType>
    sort()
    Sorts the elements in this container and returns this container.
    Stream<KType>
    stream()
    Returns this container elements as a stream.
    Object[]
    toArray()
    Default implementation of copying to an array.
    <T> T[]
    toArray(Class<T> componentClass)
    Copies all elements of this container to a dynamically created array of the given component type.
    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 java.lang.Iterable

    forEach, spliterator

    Methods inherited from interface com.carrotsearch.hppc.ObjectCollection

    removeAll, retainAll, retainAll

    Methods inherited from interface com.carrotsearch.hppc.ObjectContainer

    toArray

  • Field Details

    • EMPTY_ARRAY

      public static final Object[] EMPTY_ARRAY
      An immutable empty buffer (array).

    • buffer

      public 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 in buffer.

    • resizer

      protected final ArraySizingStrategy resizer
      Buffer resizing strategy.

  • Constructor Details

    • 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 Details

    • 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 interface ObjectIndexedContainer<KType>

    • add

      public void add(KType e1, KType e2)
      Appends two elements at the end of the list. To add more than two elements, use add (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(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 interface ObjectIndexedContainer<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 interface ObjectIndexedContainer<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 interface ObjectIndexedContainer<KType>
      Returns:
      Returns the previous value in the list.

    • removeAt

      public KType removeAt(int index)
      Removes the element at the specified position in this container and returns it.
      Specified by:
      removeAt in interface ObjectIndexedContainer<KType>
      See Also:

    • removeLast

      public KType removeLast()
      Removes and returns the last element of this container. This container must not be empty.
      Specified by:
      removeLast in interface ObjectIndexedContainer<KType>

    • removeRange

      public void removeRange(int fromIndex, int toIndex)
      Removes from this container all of the elements with indexes between fromIndex, inclusive, and toIndex, exclusive.
      Specified by:
      removeRange in interface ObjectIndexedContainer<KType>

    • removeElement

      public boolean removeElement(KType e1)
      Removes the first element that equals e1, returning whether an element has been removed.
      Specified by:
      removeElement in interface ObjectIndexedContainer<KType>

    • removeFirst

      public int removeFirst(KType e1)
      Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.
      Specified by:
      removeFirst in interface ObjectIndexedContainer<KType>

    • removeLast

      public int removeLast(KType e1)
      Removes the last element that equals e1, returning its deleted position or -1 if the element was not found.
      Specified by:
      removeLast in interface ObjectIndexedContainer<KType>

    • removeAll

      public int removeAll(KType e1)
      Removes all occurrences of e from this collection.
      Specified by:
      removeAll in interface ObjectCollection<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 interface ObjectContainer<KType>
      Returns:
      Returns true if this container has an element equal to e.

    • 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 interface ObjectIndexedContainer<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 interface ObjectIndexedContainer<KType>

    • isEmpty

      public boolean isEmpty()
      Shortcut for size() == 0.
      Specified by:
      isEmpty in interface ObjectContainer<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 interface Preallocable
      Parameters:
      expectedElements - The total number of elements, inclusive.

    • ensureBufferSpace

      protected void ensureBufferSpace(int expectedAdditions)
      Ensures the internal buffer has enough free slots to store expectedAdditions. 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 (use 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).

    • size

      public int size()
      Return the current number of elements in this container. The time for calculating the container's size may take O(n) time, although implementing classes should try to maintain the current size and return in constant time.
      Specified by:
      size in interface ObjectContainer<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 the elementsCount field to zero.
      Specified by:
      clear in interface ObjectCollection<KType>
      See Also:

    • release

      public void release()
      Sets the number of stored elements to zero and releases the internal storage array.
      Specified by:
      release in interface ObjectCollection<KType>
      See Also:

    • toArray

      public 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 interface ObjectContainer<KType>

    • stream

      public Stream<KType> stream()
      Returns this container elements as a stream.
      Specified by:
      stream in interface ObjectIndexedContainer<KType>

    • sort

      public ObjectIndexedContainer<KType> sort()
      Sorts the elements in this container and returns this container.
      Specified by:
      sort in interface ObjectIndexedContainer<KType>

    • reverse

      public ObjectIndexedContainer<KType> reverse()
      Reverses the elements in this container and returns this container.
      Specified by:
      reverse in interface ObjectIndexedContainer<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 class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Returns 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.
      Overrides:
      equals in class Object

    • equalElements

      protected boolean equalElements(ObjectArrayList<?> other)
      Compare index-aligned elements against another ObjectIndexedContainer. Equality comparison is performed with this object's equals(Object, Object) method.

    • ramBytesAllocated

      public long ramBytesAllocated()
      Description copied from interface: Accountable
      Allocated memory estimation
      Specified by:
      ramBytesAllocated in interface Accountable
      Returns:
      Ram allocated in bytes

    • ramBytesUsed

      public long ramBytesUsed()
      Description copied from interface: Accountable
      Bytes that is actually been used
      Specified by:
      ramBytesUsed in interface Accountable
      Returns:
      Ram used in bytes

    • iterator

      public 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 interface Iterable<KType>
      Specified by:
      iterator in interface ObjectContainer<KType>

    • forEach

      public <T extends ObjectProcedure<? super KType>> T forEach(T procedure)
      Applies a 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;
      Specified by:
      forEach in interface ObjectContainer<KType>

    • forEach

      public <T extends ObjectProcedure<? super KType>> T forEach(T procedure, int fromIndex, int toIndex)
      Applies procedure to a slice of the list, fromIndex, inclusive, to toIndex, exclusive.

    • removeAll

      public int removeAll(ObjectPredicate<? super KType> predicate)
      Removes all elements in this collection for which the given predicate returns true .
      Specified by:
      removeAll in interface ObjectCollection<KType>
      Returns:
      Returns the number of removed elements.

    • forEach

      public <T extends ObjectPredicate<? super KType>> T forEach(T predicate)
      Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.
      Specified by:
      forEach in interface ObjectContainer<KType>

    • forEach

      public <T extends ObjectPredicate<? super KType>> T 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.

    • from

      @SafeVarargs public static <KType> ObjectArrayList<KType> from(KType... elements)
      Create a list from a variable number of arguments or an array of Object. 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 interface ObjectCollection<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 interface ObjectCollection<KType>
      Returns:
      Returns the number of removed elements.

    • retainAll

      public int retainAll(ObjectPredicate<? super KType> predicate)
      Default implementation redirects to ObjectCollection.removeAll(ObjectPredicate) and negates the predicate.
      Specified by:
      retainAll in interface ObjectCollection<KType>
      Returns:
      Returns the number of removed elements.

    • toArray

      public <T> T[] toArray(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 interface ObjectContainer<KType>

    • toString

      public String toString()
      Convert the contents of this container to a human-friendly string.
      Overrides:
      toString in class Object

    • equals

      protected boolean equals(Object v1, Object v2)