ByteArrayList (HPPC v0.6.0 API Documentation (JavaDoc))

java.lang.Object
- com.carrotsearch.hppc.ByteArrayList

All Implemented Interfaces:

ByteCollection, ByteContainer, ByteIndexedContainer, java.lang.Cloneable, java.lang.Iterable<ByteCursor>, java.util.RandomAccess

Direct Known Subclasses:

ByteStack
```
@Generated(date="2014-04-08T14:32:52+0200",
           value="HPPC generated from: ByteArrayList.java")
public class ByteArrayList
extends java.lang.Object
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.
See ObjectArrayList class for API similarities and differences against Java Collections.

Field Summary

Fields
Modifier and Type	Field and Description
`byte[]`	`buffer` Internal array for storing the list.
`static int`	`DEFAULT_CAPACITY` Default capacity if no other capacity is given in the constructor.
`int`	`elementsCount` Current number of elements stored in `buffer`.
`protected ArraySizingStrategy`	`resizer` Buffer resizing strategy.

Constructor Summary

Constructors
Constructor and Description
`ByteArrayList()` Create with default sizing strategy and initial capacity for storing 5 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

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.
`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.
`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)` Compares the specified object with this container for equality.
`<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.
`boolean`	`isEmpty()` Shortcut for `size() == 0`.
`java.util.Iterator<ByteCursor>`	`iterator()` Returns an iterator to a cursor traversing the collection.
`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`	`newInstanceWithCapacity(int initialCapacity)` Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
`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(ByteLookupContainer c)` Default implementation uses a predicate for removal.
`int`	`removeAll(BytePredicate predicate)` Removes all elements in this collection for which the given predicate returns `true`.
`int`	`removeAllOccurrences(byte e1)` Removes all occurrences of `e` from this collection.
`int`	`removeFirstOccurrence(byte e1)` Removes the first element that equals `e1`, returning its deleted position or `-1` if the element was not found.
`int`	`removeLastOccurrence(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.
`int`	`retainAll(ByteLookupContainer c)` Default implementation uses a predicate for retaining.
`int`	`retainAll(BytePredicate predicate)` Default implementation redirects to `ByteCollection.removeAll(BytePredicate)` and negates the predicate.
`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.
`byte[]`	`toArray()` Default implementation of copying to an array.
`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.ByteCollection
removeAll, retainAll, retainAll

- Field Detail
  - DEFAULT_CAPACITY
```
public static final int DEFAULT_CAPACITY
```
    Default capacity if no other capacity is given in the constructor.
    
    See Also:
    Constant Field Values
  - buffer
```
public byte[] 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 Detail
  - ByteArrayList
```
public ByteArrayList()
```
    Create with default sizing strategy and initial capacity for storing 5 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.
  - 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)
  - addAll
```
public int addAll(ByteContainer container)
```
    Adds all elements from another container.
  - addAll
```
public int addAll(java.lang.Iterable<? extends ByteCursor> iterable)
```
    Adds all elements from another 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.
  - get
```
public byte get(int index)
```
    Specified by:
    
    get in interface ByteIndexedContainer
    
    Returns:
    Returns the element at index index from the list.
  - set
```
public byte set(int index,
       byte e1)
```
    Replaces the element at the specified position in this list with the specified element.
    
    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.
    Careful. Do not confuse this method with the overridden signature in Java Collections (List.remove(Object)). Use: ByteCollection.removeAll(com.carrotsearch.hppc.ByteLookupContainer), ByteIndexedContainer.removeFirstOccurrence(byte) or ByteIndexedContainer.removeLastOccurrence(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
  - removeFirstOccurrence
```
public int removeFirstOccurrence(byte e1)
```
    Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.
    
    Specified by:
    
    removeFirstOccurrence in interface ByteIndexedContainer
  - removeLastOccurrence
```
public int removeLastOccurrence(byte e1)
```
    Removes the last element that equals e1, returning its deleted position or -1 if the element was not found.
    
    Specified by:
    
    removeLastOccurrence in interface ByteIndexedContainer
  - removeAllOccurrences
```
public int removeAllOccurrences(byte e1)
```
    Removes all occurrences of e from this collection.
    
    Specified by:
    
    removeAllOccurrences 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
  - isEmpty
```
public boolean isEmpty()
```
    Shortcut for size() == 0.
    
    Specified by:
    
    isEmpty in interface ByteContainer
  - 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), 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 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. 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 ByteCollection
  - release
```
public void release()
```
    Sets the number of stored elements to zero and releases the internal storage array.
  - toArray
```
public byte[] 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 ByteContainer
  - clone
```
public ByteArrayList clone()
```
    Clone this object. The returned clone will reuse the same hash function and array resizing strategy.
    
    Overrides:
    
    clone in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface ByteIndexedContainer
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    A hash code of elements stored in the container. The hash code is defined identically to List.hashCode() (should be implemented with the same algorithm).
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Compares the specified object with this container for equality. Returns true if and only if the specified object is also a ByteIndexedContainer, both have the same size, and all corresponding pairs of elements at the same index are equal. In other words, two indexed containers are defined to be equal if they contain the same elements in the same order.
    Note that, unlike in List, containers may be of different types and still return true from ByteIndexedContainer.equals(java.lang.Object). This may be dangerous if you use different hash functions in two containers, but don't override the default implementation of ByteIndexedContainer.equals(java.lang.Object). It is the programmer's responsibility to enforcing these contracts properly.
    
    Specified by:
    
    equals in interface ByteIndexedContainer
    
    Overrides:
    
    equals in class java.lang.Object
  - iterator
```
public java.util.Iterator<ByteCursor> 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 (ByteCursor<byte> c : container) {
   System.out.println("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.
  - 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
  - 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.
  - 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).
  - newInstanceWithCapacity
```
public static ByteArrayList newInstanceWithCapacity(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. The elements are copied from the argument to the internal buffer.
  - from
```
public static ByteArrayList from(ByteContainer container)
```
    Create a list from elements of another container.
  - removeAll
```
public int removeAll(ByteLookupContainer c)
```
    Default implementation uses a predicate for removal.
    
    Specified by:
    
    removeAll in interface ByteCollection
    
    Returns:
    Returns the number of removed elements.
  - retainAll
```
public int retainAll(ByteLookupContainer c)
```
    Default implementation uses a predicate for retaining.
    
    Specified by:
    
    retainAll in interface ByteCollection
    
    Returns:
    Returns the number of removed elements.
  - retainAll
```
public int retainAll(BytePredicate predicate)
```
    Default implementation redirects to ByteCollection.removeAll(BytePredicate) and negates the predicate.
    
    Specified by:
    
    retainAll in interface ByteCollection
  - toString
```
public java.lang.String toString()
```
    Convert the contents of this container to a human-friendly string.
    
    Overrides:
    
    toString in class java.lang.Object

Class ByteArrayList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.carrotsearch.hppc.ByteCollection

Field Detail

DEFAULT_CAPACITY

buffer

elementsCount

resizer

Constructor Detail

ByteArrayList

ByteArrayList

ByteArrayList

ByteArrayList

Method Detail

add

add

add

add

addAll

addAll

insert

get

set

remove

removeRange

removeFirstOccurrence

removeLastOccurrence

removeAllOccurrences

contains

indexOf

lastIndexOf

isEmpty

ensureCapacity

ensureBufferSpace

resize

size

trimToSize

clear

release

toArray

clone

hashCode

equals

iterator

forEach

forEach

removeAll

forEach

forEach

newInstance

newInstanceWithCapacity

from

from

removeAll

retainAll

retainAll

toString