ByteArrayList (HPPC-RT v0.7.5 API Documentation)

java.lang.Object
- com.carrotsearch.hppcrt.AbstractByteCollection
- - com.carrotsearch.hppcrt.lists.ByteArrayList

All Implemented Interfaces:

ByteCollection, ByteContainer, ByteIndexedContainer, java.lang.Cloneable, java.lang.Iterable<ByteCursor>, java.util.RandomAccess
```
@Generated(date="2017-07-11T19:16:25+0200",
           value="KTypeArrayList.java")
public class ByteArrayList
extends AbstractByteCollection
implements ByteIndexedContainer, java.lang.Cloneable
```
An array-backed list of bytes. A single array is used to store and manipulate all elements. Reallocations are governed by a 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)
See ObjectArrayList class for API similarities and differences against Java Collections.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ByteArrayList.ValueIterator
An iterator implementation for ObjectArrayList.iterator().

Nested Classes
Modifier and Type	Class and Description
`class`	`ByteArrayList.ValueIterator` An iterator implementation for `ObjectArrayList.iterator()`.

Field Summary

Fields
Modifier and Type	Field and Description
`byte[]`	`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<ByteCursor,ByteArrayList.ValueIterator>`	`valueIteratorPool` internal pool of ValueIterator (must be created in constructor)

Fields inherited from class com.carrotsearch.hppcrt.AbstractByteCollection
containsNegateTestPredicate, containsTestPredicate, negatePredicate, testContainer, testPredicate

Constructor Summary

Constructors
Constructor and Description
`ByteArrayList()` Default constructor: Create with default sizing strategy and initial capacity for storing `Containers.DEFAULT_EXPECTED_ELEMENTS` elements.
`ByteArrayList(ByteContainer container)` Creates a new list from elements of another container.
`ByteArrayList(int initialCapacity)` Create with default sizing strategy and the given initial capacity.
`ByteArrayList(int initialCapacity, ArraySizingStrategy resizer)` Create with a custom buffer resizing strategy.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(byte... elements)` Vararg-signature method for adding elements at the end of the list.
`void`	`add(byte e1)` Adds an element to the end of this container (the last index is incremented by one).
`void`	`add(byte[] elements, int start, int length)` Add all elements from a range of given array to the list.
`void`	`add(byte e1, byte e2)` Appends two elements at the end of the list.
`int`	`addAll(ByteContainer container)` Adds all elements from another container.
`int`	`addAll(java.lang.Iterable<? extends ByteCursor> iterable)` Adds all elements from another iterable.
`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.
`ByteArrayList`	`clone()` Clone this object.
`boolean`	`contains(byte 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 BytePredicate> T`	`forEach(T predicate)` Applies a `predicate` to container elements, as long as the predicate returns `true`.
`<T extends ByteProcedure> T`	`forEach(T procedure)` Applies a `procedure` to all container elements.
`<T extends BytePredicate> 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`.
`<T extends ByteProcedure> T`	`forEach(T procedure, int fromIndex, int toIndex)` Applies `procedure` to a slice of the list, `fromIndex`, inclusive, to `toIndex`, exclusive.
`static ByteArrayList`	`from(byte... elements)` Create a list from a variable number of arguments or an array of `byte`.
`static ByteArrayList`	`from(ByteContainer container)` Create a list from elements of another container.
`byte`	`get(int index)`
`int`	`hashCode()`
`int`	`indexOf(byte 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, byte e1)` Inserts the specified element at the specified position in this list.
`ByteArrayList.ValueIterator`	`iterator()` Returns an iterator over the values of this list.
`int`	`lastIndexOf(byte 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 ByteArrayList`	`newInstance()` Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
`static ByteArrayList`	`newInstance(int initialCapacity)` Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
`byte`	`peekLast()` Stack emulating method: Peek at the last element on the array.
`byte`	`popLast()` Stack emulating method: Discard the last element of the array, and return it.
`int`	`pushAllLast(ByteContainer container)` Stack emulating method: Pushes all elements from another container at the end of the array, synonym of `addAll(ByteContainer)`
`int`	`pushAllLast(java.lang.Iterable<? extends ByteCursor> iterable)` Stack emulating method: Pushes all elements from another iterable to the end of the array, synonym of `addAll(Iterable)`
`void`	`pushLast(byte... elements)` Stack emulating method: Vararg-signature method for pushing elements at the end of the array.
`void`	`pushLast(byte e1)` Stack emulating method: Adds one byte at the end of the array, equivalent of `add(byte)`
`void`	`pushLast(byte[] elements, int start, int len)` Stack emulating method: Add a range of array elements at the end of array, synonym of `add(byte[], int, int)`
`void`	`pushLast(byte e1, byte e2)` Stack emulating method: Adds two bytes at the end of the array, synonym of `add(byte, byte)`
`void`	`pushLast(byte e1, byte e2, byte e3)` Stack emulating method: Adds three bytes at the end of the array
`void`	`pushLast(byte e1, byte e2, byte e3, byte e4)` Stack emulating method: Adds four bytes at the end of the array
`void`	`release()` Sets the number of stored elements to zero and releases the internal storage array.
`byte`	`remove(int index)` Removes the element at the specified position in this list and returns it.
`int`	`removeAll(byte e1)` Removes all occurrences of `e` from this collection.
`int`	`removeAll(BytePredicate predicate)` Removes all elements in this collection for which the given predicate returns `true`.
`int`	`removeFirst(byte e1)` Removes the first element that equals `e1`, returning its deleted position or `-1` if the element was not found.
`int`	`removeLast(byte 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.
`byte`	`set(int index, byte 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)
`void`	`sort(ByteComparator comp)` In-place sort the whole list using a `ByteComparator`
`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, ByteComparator comp)` In-place sort the list from [beginIndex, endIndex[ using a `ByteComparator` * @param beginIndex the start index to be sorted
`byte[]`	`toArray(byte[] 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.

Methods inherited from class com.carrotsearch.hppcrt.AbstractByteCollection
isEmpty, removeAll, retainAll, retainAll, toArray, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.carrotsearch.hppcrt.ByteCollection
removeAll, retainAll, retainAll

Methods inherited from interface com.carrotsearch.hppcrt.ByteContainer
isEmpty, toArray

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - buffer
```
public byte[] buffer
```
    Internal array for storing the list. The array may be larger than the current size (size()).
    Direct list iteration: iterate buffer[i] for i in [0; size()[
  - elementsCount
```
protected int elementsCount
```
    Current number of elements stored in buffer.
  - resizer
```
protected final ArraySizingStrategy resizer
```
    Buffer resizing strategy.
  - valueIteratorPool
```
protected final IteratorPool<ByteCursor,ByteArrayList.ValueIterator> valueIteratorPool
```
    internal pool of ValueIterator (must be created in constructor)
- Constructor Detail
  - ByteArrayList
```
public ByteArrayList()
```
    Default constructor: Create with default sizing strategy and initial capacity for storing Containers.DEFAULT_EXPECTED_ELEMENTS elements.
    
    See Also:
    
    BoundedProportionalArraySizingStrategy
  - ByteArrayList
```
public ByteArrayList(int initialCapacity)
```
    Create with default sizing strategy and the given initial capacity.
    
    See Also:
    
    BoundedProportionalArraySizingStrategy
  - ByteArrayList
```
public ByteArrayList(int initialCapacity,
                     ArraySizingStrategy resizer)
```
    Create with a custom buffer resizing strategy.
  - ByteArrayList
```
public ByteArrayList(ByteContainer container)
```
    Creates a new list from elements of another container.
- Method Detail
  - add
```
public void add(byte e1)
```
    Adds an element to the end of this container (the last index is incremented by one).
    
    Specified by:
    
    add in interface ByteIndexedContainer
  - add
```
public void add(byte e1,
                byte 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(byte[] elements,
                int start,
                int length)
```
    Add all elements from a range of given array to the list.
    
    Parameters:
    
    elements -
    
    start -
    
    length -
  - add
```
public void add(byte... 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)
    
    Parameters:
    
    elements -
  - addAll
```
public int addAll(ByteContainer container)
```
    Adds all elements from another container.
    
    Parameters:
    
    container -
    
    Returns:
    
    the number of elements added from the container
  - addAll
```
public int addAll(java.lang.Iterable<? extends ByteCursor> iterable)
```
    Adds all elements from another iterable.
    
    Parameters:
    
    iterable -
    
    Returns:
    
    the number of elements added from the iterable
  - insert
```
public void insert(int index,
                   byte e1)
```
    Inserts the specified element at the specified position in this list.
    
    Specified by:
    
    insert in interface ByteIndexedContainer
    
    Parameters:
    
    index - The index at which the element should be inserted, shifting any existing and subsequent elements to the right. Precondition : index must be valid !
  - get
```
public byte get(int index)
```
    Specified by:
    
    get in interface ByteIndexedContainer
    
    Returns:
    
    Returns the element at index index from the list. Precondition : index must be valid !
  - set
```
public byte set(int index,
                byte e1)
```
    Replaces the element at the specified position in this list with the specified element. Precondition : index must be valid !
    
    Specified by:
    
    set in interface ByteIndexedContainer
    
    Returns:
    
    Returns the previous value in the list.
  - remove
```
public byte remove(int index)
```
    Removes the element at the specified position in this list and returns it. Precondition : index must be valid !
    Careful. Do not confuse this method with the overridden signature in Java Collections (List.remove(Object)). Use: ByteCollection.removeAll(byte), ByteIndexedContainer.removeFirst(byte) or ByteIndexedContainer.removeLast(byte) depending on the actual need.
    
    Specified by:
    
    remove in interface ByteIndexedContainer
  - removeRange
```
public void removeRange(int fromIndex,
                        int toIndex)
```
    Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.
    
    Specified by:
    
    removeRange in interface ByteIndexedContainer
  - removeFirst
```
public int removeFirst(byte 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 ByteIndexedContainer
  - removeLast
```
public int removeLast(byte 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 ByteIndexedContainer
  - removeAll
```
public int removeAll(byte e1)
```
    Removes all occurrences of e from this collection.
    
    Specified by:
    
    removeAll in interface ByteCollection
    
    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(byte 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 ByteContainer
    
    Returns:
    
    Returns true if this container has an element equal to e.
  - indexOf
```
public int indexOf(byte 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 ByteIndexedContainer
  - lastIndexOf
```
public int lastIndexOf(byte 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 ByteIndexedContainer
  - ensureCapacity
```
public 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.
  - 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). 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 ByteContainer
  - capacity
```
public int capacity()
```
    Return the maximum number of elements this container is guaranteed to hold without reallocating. The time for calculating the container's capacity may take O(n) time.
    
    Specified by:
    
    capacity in interface ByteContainer
  - trimToSize
```
public void trimToSize()
```
    Trim the internal buffer to the current size.
  - clear
```
public void clear()
```
    Sets the number of stored elements to zero.
    
    Specified by:
    
    clear in interface ByteCollection
  - release
```
public void release()
```
    Sets the number of stored elements to zero and releases the internal storage array.
  - toArray
```
public byte[] toArray(byte[] target)
```
    Default implementation for: Copies all elements of this container to an existing array of the same type.
    
    Specified by:
    
    toArray in interface ByteContainer
    
    Overrides:
    
    toArray in class AbstractByteCollection
    
    Parameters:
    
    target - The target array must be large enough to hold all elements, i.e >= ByteContainer.size().
    
    Returns:
    
    Returns the target argument for chaining.
  - clone
```
public ByteArrayList clone()
```
    Clone this object.
    
    Overrides:
    
    clone in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - iterator
```
public ByteArrayList.ValueIterator iterator()
```
    Returns an iterator over the values of this list. 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 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 (Iterator i = intDeque.descendingIterator(); i.hasNext(); )
 {
   final IntCursor c = i.next();
     System.out.println("buffer index="
         + c.index + " value=" + c.value);
 }
 
```
    Specified by:
    
    iterator in interface ByteContainer
    
    Specified by:
    
    iterator in interface java.lang.Iterable<ByteCursor>
  - forEach
```
public <T extends ByteProcedure> T forEach(T procedure)
```
    Applies a procedure to all container elements. Returns the argument (any subclass of ByteProcedure. 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 ByteContainer
  - forEach
```
public <T extends ByteProcedure> T forEach(T procedure,
                                           int fromIndex,
                                           int toIndex)
```
    Applies procedure to a slice of the list, fromIndex, inclusive, to toIndex, exclusive.
    
    Specified by:
    
    forEach in interface ByteIndexedContainer
  - removeAll
```
public int removeAll(BytePredicate predicate)
```
    Removes all elements in this collection for which the given predicate returns true.
    
    Specified by:
    
    removeAll in interface ByteCollection
    
    Returns:
    
    Returns the number of removed elements.
  - forEach
```
public <T extends BytePredicate> 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 ByteContainer
  - forEach
```
public <T extends BytePredicate> 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.
    
    Specified by:
    
    forEach in interface ByteIndexedContainer
  - newInstance
```
public static ByteArrayList newInstance()
```
    Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
  - newInstance
```
public static ByteArrayList newInstance(int initialCapacity)
```
    Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
  - from
```
public static ByteArrayList from(byte... elements)
```
    Create a list from a variable number of arguments or an array of byte.
  - from
```
public static ByteArrayList from(ByteContainer container)
```
    Create a list from elements of another container.
  - sort
```
public void sort(int beginIndex,
                 int endIndex)
```
    In-place sort the list from [beginIndex, endIndex[ by natural ordering (smaller first)
    
    Parameters:
    
    beginIndex - the start index to be sorted
    
    endIndex - the end index to be sorted (excluded)
  - sort
```
public void sort()
```
    In-place sort the whole list by natural ordering (smaller first)
  - sort
```
public void sort(int beginIndex,
                 int endIndex,
                 ByteComparator comp)
```
    In-place sort the list from [beginIndex, endIndex[ using a ByteComparator * @param beginIndex the start index to be sorted
    
    Parameters:
    
    endIndex - the end index to be sorted (excluded)
  - sort
```
public void sort(ByteComparator comp)
```
    In-place sort the whole list using a ByteComparator
  - pushLast
```
public void pushLast(byte e1)
```
    Stack emulating method: Adds one byte at the end of the array, equivalent of add(byte)
    
    Parameters:
    
    e1 -
  - pushLast
```
public void pushLast(byte e1,
                     byte e2)
```
    Stack emulating method: Adds two bytes at the end of the array, synonym of add(byte, byte)
    
    Parameters:
    
    e1 -
    
    e2 -
  - pushLast
```
public void pushLast(byte e1,
                     byte e2,
                     byte e3)
```
    Stack emulating method: Adds three bytes at the end of the array
    
    Parameters:
    
    e1 -
    
    e2 -
    
    e3 -
  - pushLast
```
public void pushLast(byte e1,
                     byte e2,
                     byte e3,
                     byte e4)
```
    Stack emulating method: Adds four bytes at the end of the array
    
    Parameters:
    
    e1 -
    
    e2 -
    
    e3 -
    
    e4 -
  - pushLast
```
public void pushLast(byte[] elements,
                     int start,
                     int len)
```
    Stack emulating method: Add a range of array elements at the end of array, synonym of add(byte[], int, int)
  - pushLast
```
public final void pushLast(byte... elements)
```
    Stack emulating method: Vararg-signature method for pushing elements at the end of the array.
    This method is handy, but costly if used in tight loops (anonymous array passing)
  - pushAllLast
```
public int pushAllLast(ByteContainer container)
```
    Stack emulating method: Pushes all elements from another container at the end of the array, synonym of addAll(ByteContainer)
  - pushAllLast
```
public int pushAllLast(java.lang.Iterable<? extends ByteCursor> iterable)
```
    Stack emulating method: Pushes all elements from another iterable to the end of the array, synonym of addAll(Iterable)
    
    Parameters:
    
    iterable -
  - discardLast
```
public void discardLast(int count)
```
    Stack emulating method: Discard an arbitrary number of elements from the end of the array.
    
    Parameters:
    
    count -
  - discardLast
```
public void discardLast()
```
    Stack emulating method: Discard the last element of the array.
  - popLast
```
public byte popLast()
```
    Stack emulating method: Discard the last element of the array, and return it.
  - peekLast
```
public byte peekLast()
```
    Stack emulating method: Peek at the last element on the array.

Class ByteArrayList

Nested Class Summary

Field Summary

Fields inherited from class com.carrotsearch.hppcrt.AbstractByteCollection

Constructor Summary

Method Summary

Methods inherited from class com.carrotsearch.hppcrt.AbstractByteCollection

Methods inherited from class java.lang.Object

Methods inherited from interface com.carrotsearch.hppcrt.ByteCollection

Methods inherited from interface com.carrotsearch.hppcrt.ByteContainer

Methods inherited from interface java.lang.Iterable

Field Detail

buffer

elementsCount

resizer

valueIteratorPool

Constructor Detail

ByteArrayList

ByteArrayList

ByteArrayList

ByteArrayList

Method Detail

add

add

add

add

addAll

addAll

insert

get

set

remove

removeRange

removeFirst

removeLast

removeAll

contains

indexOf

lastIndexOf

ensureCapacity

ensureBufferSpace

resize

size

capacity

trimToSize

clear

release

toArray

clone

hashCode

equals

iterator

forEach

forEach

removeAll

forEach

forEach

newInstance

newInstance

from

from

sort

sort

sort

sort

pushLast

pushLast

pushLast

pushLast

pushLast

pushLast

pushAllLast

pushAllLast

discardLast

discardLast

popLast

peekLast