ByteArrayList (Primitive-Collections 0.8.0 API)

java.lang.Object
- java.util.AbstractCollection<java.lang.Byte>
- - speiger.src.collections.bytes.collections.AbstractByteCollection
  - - speiger.src.collections.bytes.lists.AbstractByteList
    - - speiger.src.collections.bytes.lists.ByteArrayList

All Implemented Interfaces:

java.lang.Iterable<java.lang.Byte>, java.util.Collection<java.lang.Byte>, java.util.List<java.lang.Byte>, java.util.RandomAccess, ByteCollection, ByteIterable, ByteStack, ByteList, IByteArray, IArray, ISizeProvider, ITrimmable
```
public class ByteArrayList
extends AbstractByteList
implements IByteArray, ByteStack
```
A Type-Specific Array-based implementation of list that is written to reduce (un)boxing
This implementation is optimized to improve how data is processed with interfaces like IByteArray, ByteStack and with optimized functions that use type-specific implementations for primitives and optimized logic for bulkactions.

Nested Class Summary
- Nested classes/interfaces inherited from interface speiger.src.collections.utils.ISizeProvider
  ISizeProvider.CollectionSize

Constructor Summary

Constructors
Constructor and Description
`ByteArrayList()` Creates a new ArrayList with a Empty array.
`ByteArrayList(byte... a)` Creates a new ArrayList with a Copy of the array
`ByteArrayList(byte[] a, int length)` Creates a new ArrayList with a Copy of the array with a custom length
`ByteArrayList(byte[] a, int offset, int length)` Creates a new ArrayList with a Copy of the array with in the custom range.
`ByteArrayList(ByteCollection c)` Creates a new ArrayList a copy with the contents of the Collection.
`ByteArrayList(ByteList l)` Creates a new ArrayList a copy with the contents of the List.
`ByteArrayList(java.util.Collection<? extends java.lang.Byte> c)` Deprecated.
`ByteArrayList(int size)` Creates a new ArrayList with the specific requested size

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(byte e)` Appends the specified element to the end of this list.
`void`	`add(int index, byte e)` Appends the specified element to the index of the list
`boolean`	`addAll(byte[] e, int offset, int length)` A Type-Specific Array based addAll method to reduce the amount of Wrapping
`boolean`	`addAll(int index, ByteCollection c)` Appends the specified elements to the index of the list.
`boolean`	`addAll(int index, ByteList c)` Appends the specified elements to the index of the list.
`boolean`	`addAll(int index, java.util.Collection<? extends java.lang.Byte> c)` Deprecated.
`void`	`addElements(int from, byte[] a, int offset, int length)` Appends the specified array elements to the index of the list.
`void`	`clear()` A function to clear all elements in the list.
`void`	`clearAndTrim(int size)` Trims the collection down to the requested size and clears all elements while doing so
`boolean`	`contains(byte e)` A Type Specific implementation of the Collection#contains function.
`boolean`	`contains(java.lang.Object o)` Deprecated.
`ByteArrayList`	`copy()` A Function that does a shallow clone of the Collection itself.
`int`	`count(BytePredicate filter)` Helper function to reduce stream usage that allows to count the valid elements.
`byte[]`	`elements()` Provides the Underlying Array in the Implementation
`void`	`ensureCapacity(int size)` Increases the capacity of this implementation instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
`byte[]`	`extractElements(int from, int to)` A function to fast extract elements out of the list, this removes the elements that were fetched.
`void`	`fillBuffer(java.nio.ByteBuffer buffer)` Helper function that allows to fastFill a buffer reducing the duplication requirement
`byte`	`findFirst(BytePredicate filter)` Helper function to reduce stream usage that allows to filter for the first match.
`void`	`forEach(ByteConsumer action)` A Type Specific foreach function that reduces (un)boxing
`<E> void`	`forEach(E input, ObjectByteConsumer<E> action)` Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
`byte`	`getByte(int index)` A Type-Specific get function to reduce (un)boxing
`byte[]`	`getElements(int from, byte[] a, int offset, int length)` A function to fast fetch elements from the list
`int`	`indexOf(byte e)` A Type-Specific function to find the index of a given element
`int`	`indexOf(java.lang.Object o)` Deprecated.
`int`	`lastIndexOf(byte e)` A Type-Specific function to find the last index of a given element
`int`	`lastIndexOf(java.lang.Object o)` Deprecated.
`boolean`	`matchesAll(BytePredicate filter)` Helper function to reduce stream usage that allows to filter for all matches.
`boolean`	`matchesAny(BytePredicate filter)` Helper function to reduce stream usage that allows to filter for any matches.
`boolean`	`matchesNone(BytePredicate filter)` Helper function to reduce stream usage that allows to filter for no matches.
`byte`	`peek(int index)` Provides the Selected Object from the stack.
`byte`	`pop()` A Type-Specific pop function to reduce (un)boxing
`java.util.stream.IntStream`	`primitiveStream()` Returns a Java-Type-Specific Stream to reduce boxing/unboxing.
`void`	`push(byte e)` Appends the specified element to the end of this Stack.
`byte`	`reduce(byte identity, ByteByteUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`byte`	`reduce(ByteByteUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`boolean`	`remByte(byte type)` A Type-Specific implementation of remove.
`boolean`	`remIf(java.util.function.IntPredicate filter)` A optimized List#removeIf(Predicate) that more quickly removes elements from the list then the ArrayList implementation
`boolean`	`removeAll(ByteCollection c)` A function to remove all elements that were provided in the other collection
`boolean`	`removeAll(ByteCollection c, ByteConsumer r)` A Type-Specific removeAll function that reduces (un)boxing.
`boolean`	`removeAll(java.util.Collection<?> c)` Deprecated.
`byte`	`removeByte(int index)` A Type-Specific remove function to reduce (un)boxing
`void`	`removeElements(int from, int to)` a function to fast remove elements from the list.
`boolean`	`removeIf(java.util.function.Predicate<? super java.lang.Byte> filter)` Deprecated.
`void`	`replaceAll(java.util.function.UnaryOperator<java.lang.Byte> o)` Deprecated.
`void`	`replaceBytes(java.util.function.IntUnaryOperator o)` A Type-Specific replace function to reduce (un)boxing
`boolean`	`retainAll(ByteCollection c)` A function to retain all elements that were provided in the other collection This function might delegate to a more appropriate function if necessary
`boolean`	`retainAll(ByteCollection c, ByteConsumer r)` A Type-Specific retainAll function that reduces (un)boxing.
`boolean`	`retainAll(java.util.Collection<?> c)` Deprecated.
`byte`	`set(int index, byte e)` A Type-Specific set function to reduce (un)boxing
`int`	`size()` A function to return the size of the list
`void`	`size(int size)` A function to ensure the elements are within the requested size.
`void`	`sort(ByteComparator c)` Sorts the elements specified by the Natural order either by using the Comparator or the elements
`ByteSplititerator`	`spliterator()` A Type Specific Type Splititerator to reduce boxing/unboxing
`byte`	`swapRemove(int index)` A Highly Optimized remove function that removes the desired element.
`java.lang.Object[]`	`toArray()` Deprecated.
`<E> E[]`	`toArray(E[] a)` Deprecated.
`byte[]`	`toByteArray(byte[] a)` A Type-Specific implementation of toArray.
`boolean`	`trim(int size)` Trims the original collection down to the size of the current elements or the requested size depending which is bigger
`void`	`unstableSort(ByteComparator c)` Sorts the elements specified by the Natural order either by using the Comparator or the elements using a unstable sort
`static ByteArrayList`	`wrap(byte... a)` Creates a wrapped arraylist that uses the array as backing array
`static ByteArrayList`	`wrap(byte[] a, int length)` Creates a wrapped arraylist that uses the array as backing array and a custom fill size

Methods inherited from class speiger.src.collections.bytes.lists.AbstractByteList
add, addAll, addAll, addAll, equals, hashCode, iterator, listIterator, listIterator, subList, swapRemoveByte

Methods inherited from class speiger.src.collections.bytes.collections.AbstractByteCollection
add, containsAll, containsAll, containsAny, containsAny, remove, toByteArray

Methods inherited from class java.util.AbstractCollection
isEmpty, toString

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

Methods inherited from interface speiger.src.collections.bytes.utils.IByteArray
elements

Methods inherited from interface speiger.src.collections.utils.ITrimmable
clearAndTrim, trim

Methods inherited from interface speiger.src.collections.bytes.collections.ByteStack
isEmpty, top

Methods inherited from interface speiger.src.collections.bytes.lists.ByteList
add, addElements, addElements, addIfAbsent, addIfPresent, forEachIndexed, get, getElements, remove, remove, set, sort, synchronize, synchronize, unmodifiable, unstableSort

Methods inherited from interface speiger.src.collections.bytes.collections.ByteCollection
addAll, addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, toByteArray

Methods inherited from interface speiger.src.collections.bytes.collections.ByteIterable
arrayflatMap, asAsync, distinct, filter, flatMap, forEach, limit, map, peek, pourAsList, pourAsSet, repeat, sorted

Methods inherited from interface speiger.src.collections.utils.ISizeProvider
of

Methods inherited from interface java.util.List
containsAll, isEmpty

Methods inherited from interface java.util.Collection
parallelStream, stream

- Constructor Detail
  - ByteArrayList
```
public ByteArrayList()
```
    Creates a new ArrayList with a Empty array.
  - ByteArrayList
```
public ByteArrayList(int size)
```
    Creates a new ArrayList with the specific requested size
    
    Parameters:
    
    size - the minimum initial size of the Backing array
  - ByteArrayList
```
@Deprecated
public ByteArrayList(java.util.Collection<? extends java.lang.Byte> c)
```
    Deprecated.
    
    Creates a new ArrayList a copy with the contents of the Collection.
    
    Parameters:
    
    c - the elements that should be added into the list
  - ByteArrayList
```
public ByteArrayList(ByteCollection c)
```
    Creates a new ArrayList a copy with the contents of the Collection.
    
    Parameters:
    
    c - the elements that should be added into the list
  - ByteArrayList
```
public ByteArrayList(ByteList l)
```
    Creates a new ArrayList a copy with the contents of the List.
    
    Parameters:
    
    l - the elements that should be added into the list
  - ByteArrayList
```
public ByteArrayList(byte... a)
```
    Creates a new ArrayList with a Copy of the array
    
    Parameters:
    
    a - the array that should be copied
  - ByteArrayList
```
public ByteArrayList(byte[] a,
                     int length)
```
    Creates a new ArrayList with a Copy of the array with a custom length
    
    Parameters:
    
    a - the array that should be copied
    
    length - the desired length that should be copied
  - ByteArrayList
```
public ByteArrayList(byte[] a,
                     int offset,
                     int length)
```
    Creates a new ArrayList with a Copy of the array with in the custom range.
    
    Parameters:
    
    a - the array that should be copied
    
    offset - the starting offset of where the array should be copied from
    
    length - the desired length that should be copied
    
    Throws:
    
    java.lang.IllegalStateException - if offset is smaller then 0
    
    java.lang.IllegalStateException - if the offset + length exceeds the array length
- Method Detail
  - wrap
```
public static ByteArrayList wrap(byte... a)
```
    Creates a wrapped arraylist that uses the array as backing array
    
    Parameters:
    
    a - elements that should be wrapped
    
    Returns:
    
    a Wrapped list using the input array
  - wrap
```
public static ByteArrayList wrap(byte[] a,
                                 int length)
```
    Creates a wrapped arraylist that uses the array as backing array and a custom fill size
    
    Parameters:
    
    a - elements that should be wrapped
    
    length - the size of the elements within the array
    
    Returns:
    
    a Wrapped list using the input array
  - add
```
public boolean add(byte e)
```
    Appends the specified element to the end of this list.
    
    Specified by:
    
    add in interface ByteCollection
    
    Specified by:
    
    add in interface ByteList
    
    Overrides:
    
    add in class AbstractByteList
    
    Parameters:
    
    e - element to be appended to this list
    
    Returns:
    
    true (as specified by Collection.add(E))
    
    See Also:
    
    List.add(Object)
  - push
```
public void push(byte e)
```
    Appends the specified element to the end of this Stack.
    
    Specified by:
    
    push in interface ByteStack
    
    Parameters:
    
    e - element to be appended to this Stack
    
    See Also:
    
    Stack.push(Object)
  - add
```
public void add(int index,
                byte e)
```
    Appends the specified element to the index of the list
    
    Specified by:
    
    add in interface ByteList
    
    Parameters:
    
    index - the index where to append the element to
    
    e - the element to append to the list
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if index is outside of the lists range
    
    See Also:
    
    List.add(int, Object)
  - addAll
```
@Deprecated
public boolean addAll(int index,
                                   java.util.Collection<? extends java.lang.Byte> c)
```
    Deprecated.
    
    Appends the specified elements to the index of the list. This function may delegate to more appropriate function if necessary
    
    Specified by:
    
    addAll in interface java.util.List<java.lang.Byte>
    
    Parameters:
    
    index - the index where to append the elements to
    
    c - the elements to append to the list
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if index is outside of the lists range
    
    java.lang.NullPointerException - if collection contains a null element
  - addAll
```
public boolean addAll(int index,
                      ByteCollection c)
```
    Appends the specified elements to the index of the list. This function may delegate to more appropriate function if necessary
    
    Specified by:
    
    addAll in interface ByteList
    
    Parameters:
    
    index - the index where to append the elements to
    
    c - the elements to append to the list
    
    Returns:
    
    true if the list was modified
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if index is outside of the lists range
    
    See Also:
    
    List.addAll(int, java.util.Collection)
  - addAll
```
public boolean addAll(int index,
                      ByteList c)
```
    Appends the specified elements to the index of the list.
    
    Specified by:
    
    addAll in interface ByteList
    
    Parameters:
    
    index - the index where to append the elements to
    
    c - the elements to append to the list
    
    Returns:
    
    true if the list was modified
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if index is outside of the lists range
  - addAll
```
public boolean addAll(byte[] e,
                      int offset,
                      int length)
```
    Description copied from interface: ByteCollection
    
    A Type-Specific Array based addAll method to reduce the amount of Wrapping
    
    Specified by:
    
    addAll in interface ByteCollection
    
    Parameters:
    
    e - the elements that should be added
    
    offset - where to start within the array
    
    length - how many elements of the array should be added
    
    Returns:
    
    if the collection was modified
  - addElements
```
public void addElements(int from,
                        byte[] a,
                        int offset,
                        int length)
```
    Appends the specified array elements to the index of the list.
    
    Specified by:
    
    addElements in interface ByteList
    
    Parameters:
    
    from - the index where to append the elements to
    
    a - the elements to append to the list
    
    offset - where to start ino the array
    
    length - the amount of elements to insert
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if index is outside of the lists range
  - getElements
```
public byte[] getElements(int from,
                          byte[] a,
                          int offset,
                          int length)
```
    A function to fast fetch elements from the list
    
    Specified by:
    
    getElements in interface ByteList
    
    Parameters:
    
    from - index where the list should be fetching elements from
    
    a - the array where the values should be inserted to
    
    offset - the startIndex of where the array should be written to
    
    length - the number of elements the values should be fetched from
    
    Returns:
    
    the inputArray
    
    Throws:
    
    java.lang.NullPointerException - if the array is null
    
    java.lang.IndexOutOfBoundsException - if from is outside of the lists range
    
    java.lang.IllegalStateException - if offset or length are smaller then 0 or exceed the array length
  - removeElements
```
public void removeElements(int from,
                           int to)
```
    a function to fast remove elements from the list.
    
    Specified by:
    
    removeElements in interface ByteList
    
    Parameters:
    
    from - the start index of where the elements should be removed from (inclusive)
    
    to - the end index of where the elements should be removed to (exclusive)
  - extractElements
```
public byte[] extractElements(int from,
                              int to)
```
    A function to fast extract elements out of the list, this removes the elements that were fetched.
    
    Specified by:
    
    extractElements in interface ByteList
    
    Parameters:
    
    from - the start index of where the elements should be fetched from (inclusive)
    
    to - the end index of where the elements should be fetched to (exclusive)
    
    Returns:
    
    a array of the elements that were fetched
  - fillBuffer
```
public void fillBuffer(java.nio.ByteBuffer buffer)
```
    Description copied from interface: ByteList
    
    Helper function that allows to fastFill a buffer reducing the duplication requirement
    
    Specified by:
    
    fillBuffer in interface ByteList
    
    Parameters:
    
    buffer - where the data should be stored in.
  - contains
```
@Deprecated
public boolean contains(java.lang.Object o)
```
    Deprecated.
    
    A function to find if the Element is present in this list.
    
    Specified by:
    
    contains in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    contains in interface java.util.List<java.lang.Byte>
    
    Specified by:
    
    contains in interface ByteCollection
    
    Specified by:
    
    contains in interface ByteList
    
    Overrides:
    
    contains in class AbstractByteCollection
    
    Parameters:
    
    o - the element that is searched for
    
    Returns:
    
    if the element was found.
  - indexOf
```
@Deprecated
public int indexOf(java.lang.Object o)
```
    Deprecated.
    
    A function to find the index of a given element
    
    Specified by:
    
    indexOf in interface java.util.List<java.lang.Byte>
    
    Specified by:
    
    indexOf in interface ByteList
    
    Overrides:
    
    indexOf in class AbstractByteList
    
    Parameters:
    
    o - the element that is searched for
    
    Returns:
    
    the index of the element if found. (if not found then -1)
  - lastIndexOf
```
@Deprecated
public int lastIndexOf(java.lang.Object o)
```
    Deprecated.
    
    A function to find the last index of a given element
    
    Specified by:
    
    lastIndexOf in interface java.util.List<java.lang.Byte>
    
    Specified by:
    
    lastIndexOf in interface ByteList
    
    Overrides:
    
    lastIndexOf in class AbstractByteList
    
    Parameters:
    
    o - the element that is searched for
    
    Returns:
    
    the last index of the element if found. (if not found then -1)
  - contains
```
public boolean contains(byte e)
```
    A Type Specific implementation of the Collection#contains function.
    
    Specified by:
    
    contains in interface ByteCollection
    
    Overrides:
    
    contains in class AbstractByteCollection
    
    Parameters:
    
    e - the element that is searched for.
    
    Returns:
    
    if the element was found
  - indexOf
```
public int indexOf(byte e)
```
    A Type-Specific function to find the index of a given element
    
    Specified by:
    
    indexOf in interface ByteList
    
    Overrides:
    
    indexOf in class AbstractByteList
    
    Parameters:
    
    e - the element that is searched for
    
    Returns:
    
    the index of the element if found. (if not found then -1)
  - lastIndexOf
```
public int lastIndexOf(byte e)
```
    A Type-Specific function to find the last index of a given element
    
    Specified by:
    
    lastIndexOf in interface ByteList
    
    Overrides:
    
    lastIndexOf in class AbstractByteList
    
    Parameters:
    
    e - the element that is searched for
    
    Returns:
    
    the last index of the element if found. (if not found then -1)
  - sort
```
public void sort(ByteComparator c)
```
    Sorts the elements specified by the Natural order either by using the Comparator or the elements
    
    Specified by:
    
    sort in interface ByteList
    
    Parameters:
    
    c - the sorter of the elements, can be null
    
    See Also:
    
    List.sort(java.util.Comparator), ByteArrays.stableSort(byte[], ByteComparator)
  - unstableSort
```
public void unstableSort(ByteComparator c)
```
    Sorts the elements specified by the Natural order either by using the Comparator or the elements using a unstable sort
    
    Specified by:
    
    unstableSort in interface ByteList
    
    Parameters:
    
    c - the sorter of the elements, can be null
    
    See Also:
    
    List.sort(java.util.Comparator), ByteArrays.unstableSort(byte[], ByteComparator)
  - getByte
```
public byte getByte(int index)
```
    A Type-Specific get function to reduce (un)boxing
    
    Specified by:
    
    getByte in interface ByteList
    
    Parameters:
    
    index - the index of the element to fetch
    
    Returns:
    
    the value of the requested index
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index is out of range
    
    See Also:
    
    List.get(int)
  - peek
```
public byte peek(int index)
```
    Provides the Selected Object from the stack. Top to bottom
    
    Specified by:
    
    peek in interface ByteStack
    
    Parameters:
    
    index - of the element that should be provided
    
    Returns:
    
    the element that was requested
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - if the index is out of bounds
    
    See Also:
    
    Stack.peek(int)
  - elements
```
public byte[] elements()
```
    Provides the Underlying Array in the Implementation
    
    Specified by:
    
    elements in interface IByteArray
    
    Returns:
    
    underlying Array
    
    Throws:
    
    java.lang.ClassCastException - if the return type does not match the underlying array. (Only for Object Implementations)
  - forEach
```
public void forEach(ByteConsumer action)
```
    A Type Specific foreach function that reduces (un)boxing
    Specified by:
    
    forEach in interface ByteIterable
    
    Parameters:
    
    action - The action to be performed for each element
    
    Throws:
    
    java.lang.NullPointerException - if the specified action is null
    
    See Also:
    
    Iterable.forEach(java.util.function.Consumer)
    
    ImplSpec:
    The default implementation behaves as if:
    for(int i = 0;i<size;i++) action.accept(data[i]);
  - forEach
```
public <E> void forEach(E input,
                        ObjectByteConsumer<E> action)
```
    Description copied from interface: ByteIterable
    
    Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
    
    Specified by:
    
    forEach in interface ByteIterable
    
    Type Parameters:
    
    E - the generic type of the Object
    
    Parameters:
    
    input - the object that should be included
    
    action - The action to be performed for each element
  - matchesAny
```
public boolean matchesAny(BytePredicate filter)
```
    Description copied from interface: ByteIterable
    
    Helper function to reduce stream usage that allows to filter for any matches.
    
    Specified by:
    
    matchesAny in interface ByteIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if any matches were found
  - matchesNone
```
public boolean matchesNone(BytePredicate filter)
```
    Description copied from interface: ByteIterable
    
    Helper function to reduce stream usage that allows to filter for no matches.
    
    Specified by:
    
    matchesNone in interface ByteIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if no matches were found
  - matchesAll
```
public boolean matchesAll(BytePredicate filter)
```
    Description copied from interface: ByteIterable
    
    Helper function to reduce stream usage that allows to filter for all matches.
    
    Specified by:
    
    matchesAll in interface ByteIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if all matches.
  - findFirst
```
public byte findFirst(BytePredicate filter)
```
    Description copied from interface: ByteIterable
    
    Helper function to reduce stream usage that allows to filter for the first match.
    
    Specified by:
    
    findFirst in interface ByteIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the found value or the null equivalent variant.
  - reduce
```
public byte reduce(byte identity,
                   ByteByteUnaryOperator operator)
```
    Description copied from interface: ByteIterable
    
    Performs a reduction on the elements of this Iterable
    
    Specified by:
    
    reduce in interface ByteIterable
    
    Parameters:
    
    identity - the start value
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns identity if nothing was found
  - reduce
```
public byte reduce(ByteByteUnaryOperator operator)
```
    Description copied from interface: ByteIterable
    
    Performs a reduction on the elements of this Iterable
    
    Specified by:
    
    reduce in interface ByteIterable
    
    Parameters:
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns null value if nothing was found
  - count
```
public int count(BytePredicate filter)
```
    Description copied from interface: ByteIterable
    
    Helper function to reduce stream usage that allows to count the valid elements.
    
    Specified by:
    
    count in interface ByteIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the amount of Valid Elements
  - set
```
public byte set(int index,
                byte e)
```
    A Type-Specific set function to reduce (un)boxing
    
    Specified by:
    
    set in interface ByteList
    
    Parameters:
    
    index - the index of the element to set
    
    e - the value that should be set
    
    Returns:
    
    the previous element
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index is out of range
    
    See Also:
    
    List.set(int, Object)
  - replaceAll
```
@Deprecated
public void replaceAll(java.util.function.UnaryOperator<java.lang.Byte> o)
```
    Deprecated.
    
    A function to replace all values in the list
    
    Specified by:
    
    replaceAll in interface java.util.List<java.lang.Byte>
    
    Specified by:
    
    replaceAll in interface ByteList
    
    Parameters:
    
    o - the action to replace the values
    
    Throws:
    
    java.lang.NullPointerException - if o is null
  - replaceBytes
```
public void replaceBytes(java.util.function.IntUnaryOperator o)
```
    A Type-Specific replace function to reduce (un)boxing
    
    Specified by:
    
    replaceBytes in interface ByteList
    
    Parameters:
    
    o - the action to replace the values
    
    Throws:
    
    java.lang.NullPointerException - if o is null
  - removeByte
```
public byte removeByte(int index)
```
    A Type-Specific remove function to reduce (un)boxing
    
    Specified by:
    
    removeByte in interface ByteList
    
    Parameters:
    
    index - the index of the element to fetch
    
    Returns:
    
    the value of the requested index
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index is out of range
    
    See Also:
    
    List.remove(int)
  - swapRemove
```
public byte swapRemove(int index)
```
    Description copied from interface: ByteList
    
    A Highly Optimized remove function that removes the desired element. But instead of shifting the elements to the left it moves the last element to the removed space.
    
    Specified by:
    
    swapRemove in interface ByteList
    
    Parameters:
    
    index - the index of the element to be removed
    
    Returns:
    
    the element previously at the specified position
  - remByte
```
public boolean remByte(byte type)
```
    A Type-Specific implementation of remove. This implementation iterates over the elements until it finds the element that is searched for or it runs out of elements. It stops after finding the first element
    
    Specified by:
    
    remByte in interface ByteCollection
    
    Overrides:
    
    remByte in class AbstractByteCollection
    
    Parameters:
    
    type - the element that is searched for
    
    Returns:
    
    true if the element was found and removed.
    
    See Also:
    
    Collection.remove(Object)
  - pop
```
public byte pop()
```
    A Type-Specific pop function to reduce (un)boxing
    
    Specified by:
    
    pop in interface ByteStack
    
    Returns:
    
    the value of the requested index
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index is out of range
    
    See Also:
    
    Stack.pop()
  - removeAll
```
@Deprecated
public boolean removeAll(java.util.Collection<?> c)
```
    Deprecated.
    
    A function to remove all elements that were provided in the other collection This function might delegate to a more appropriate function if necessary
    
    Specified by:
    
    removeAll in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    removeAll in interface java.util.List<java.lang.Byte>
    
    Overrides:
    
    removeAll in class java.util.AbstractCollection<java.lang.Byte>
    
    Parameters:
    
    c - the elements that should be removed
    
    Returns:
    
    true if the collection was modified
    
    Throws:
    
    java.lang.NullPointerException - if the collection is null
  - retainAll
```
@Deprecated
public boolean retainAll(java.util.Collection<?> c)
```
    Deprecated.
    
    A function to retain all elements that were provided in the other collection This function might delegate to a more appropriate function if necessary
    
    Specified by:
    
    retainAll in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    retainAll in interface java.util.List<java.lang.Byte>
    
    Overrides:
    
    retainAll in class java.util.AbstractCollection<java.lang.Byte>
    
    Parameters:
    
    c - the elements that should be kept. If empty, ByteArrayList#clear is called.
    
    Returns:
    
    true if the collection was modified
    
    Throws:
    
    java.lang.NullPointerException - if the collection is null
  - removeIf
```
@Deprecated
public boolean removeIf(java.util.function.Predicate<? super java.lang.Byte> filter)
```
    Deprecated.
    
    A optimized List#removeIf(Predicate) that more quickly removes elements from the list then the ArrayList implementation
    
    Specified by:
    
    removeIf in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    removeIf in interface ByteCollection
    
    Parameters:
    
    filter - the filter to remove elements
    
    Returns:
    
    true if the list was modified
  - removeAll
```
public boolean removeAll(ByteCollection c)
```
    A function to remove all elements that were provided in the other collection
    
    Specified by:
    
    removeAll in interface ByteCollection
    
    Overrides:
    
    removeAll in class AbstractByteCollection
    
    Parameters:
    
    c - the elements that should be removed
    
    Returns:
    
    true if the collection was modified
    
    Throws:
    
    java.lang.NullPointerException - if the collection is null
    
    See Also:
    
    Collection.removeAll(Collection)
  - removeAll
```
public boolean removeAll(ByteCollection c,
                         ByteConsumer r)
```
    Description copied from interface: ByteCollection
    
    A Type-Specific removeAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.
    
    Specified by:
    
    removeAll in interface ByteCollection
    
    Overrides:
    
    removeAll in class AbstractByteCollection
    
    Parameters:
    
    c - the collection of elements that should be removed
    
    r - elements that got removed
    
    Returns:
    
    true if any element was removed
    
    See Also:
    
    Collection.removeAll(Collection)
  - retainAll
```
public boolean retainAll(ByteCollection c)
```
    A function to retain all elements that were provided in the other collection This function might delegate to a more appropriate function if necessary
    
    Specified by:
    
    retainAll in interface ByteCollection
    
    Overrides:
    
    retainAll in class AbstractByteCollection
    
    Parameters:
    
    c - the elements that should be kept. If empty, ByteArrayList#clear is called.
    
    Returns:
    
    true if the collection was modified
    
    Throws:
    
    java.lang.NullPointerException - if the collection is null
    
    See Also:
    
    Collection.retainAll(Collection)
  - retainAll
```
public boolean retainAll(ByteCollection c,
                         ByteConsumer r)
```
    Description copied from interface: ByteCollection
    
    A Type-Specific retainAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.
    
    Specified by:
    
    retainAll in interface ByteCollection
    
    Overrides:
    
    retainAll in class AbstractByteCollection
    
    Parameters:
    
    c - the collection of elements that should be kept
    
    r - elements that got removed
    
    Returns:
    
    true if any element was removed
    
    See Also:
    
    Collection.retainAll(Collection)
  - remIf
```
public boolean remIf(java.util.function.IntPredicate filter)
```
    A optimized List#removeIf(Predicate) that more quickly removes elements from the list then the ArrayList implementation
    
    Specified by:
    
    remIf in interface ByteCollection
    
    Parameters:
    
    filter - the filter to remove elements
    
    Returns:
    
    true if the list was modified
    
    See Also:
    
    Collection.removeIf(Predicate)
  - toArray
```
@Deprecated
public java.lang.Object[] toArray()
```
    Deprecated.
    
    A toArray implementation that ensures the Array itself is a Object.
    
    Specified by:
    
    toArray in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    toArray in interface java.util.List<java.lang.Byte>
    
    Overrides:
    
    toArray in class java.util.AbstractCollection<java.lang.Byte>
    
    Returns:
    
    a Array of the elements in the list
  - toArray
```
@Deprecated
public <E> E[] toArray(E[] a)
```
    Deprecated.
    
    A toArray implementation that ensures the Array itself is a Object.
    
    Specified by:
    
    toArray in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    toArray in interface java.util.List<java.lang.Byte>
    
    Overrides:
    
    toArray in class java.util.AbstractCollection<java.lang.Byte>
    
    Parameters:
    
    a - original array. If null a Object array with the right size is created. If to small the Array of the same type is created with the right size
    
    Returns:
    
    a Array of the elements in the list
  - toByteArray
```
public byte[] toByteArray(byte[] a)
```
    Description copied from class: AbstractByteCollection
    
    A Type-Specific implementation of toArray. This implementation iterates over all elements and unwraps them into primitive type.
    
    Specified by:
    
    toByteArray in interface ByteCollection
    
    Overrides:
    
    toByteArray in class AbstractByteCollection
    
    Parameters:
    
    a - array that the elements should be injected to. If null or to small a new array with the right size is created
    
    Returns:
    
    an array containing all of the elements in this collection
    
    See Also:
    
    Collection.toArray(Object[])
  - size
```
public int size()
```
    A function to return the size of the list
    
    Specified by:
    
    size in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    size in interface java.util.List<java.lang.Byte>
    
    Specified by:
    
    size in interface ByteStack
    
    Specified by:
    
    size in interface ISizeProvider
    
    Specified by:
    
    size in class java.util.AbstractCollection<java.lang.Byte>
    
    Returns:
    
    the size of elements in the list
  - size
```
public void size(int size)
```
    A function to ensure the elements are within the requested size. If smaller then the stored elements they get removed as needed. If bigger it is ensured that enough room is provided depending on the implementation
    
    Specified by:
    
    size in interface ByteList
    
    Overrides:
    
    size in class AbstractByteList
    
    Parameters:
    
    size - the requested amount of elements/room for elements
  - clear
```
public void clear()
```
    A function to clear all elements in the list.
    
    Specified by:
    
    clear in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    clear in interface java.util.List<java.lang.Byte>
    
    Specified by:
    
    clear in interface ByteStack
    
    Overrides:
    
    clear in class java.util.AbstractCollection<java.lang.Byte>
  - trim
```
public boolean trim(int size)
```
    Trims the original collection down to the size of the current elements or the requested size depending which is bigger
    
    Specified by:
    
    trim in interface ITrimmable
    
    Parameters:
    
    size - the requested trim size.
    
    Returns:
    
    if the internal array has been trimmed.
  - clearAndTrim
```
public void clearAndTrim(int size)
```
    Trims the collection down to the requested size and clears all elements while doing so
    
    Specified by:
    
    clearAndTrim in interface ITrimmable
    
    Parameters:
    
    size - the amount of elements that should be allowed
    
    Note:
    
    this will enforce minimum size of the collection itself
  - ensureCapacity
```
public void ensureCapacity(int size)
```
    Increases the capacity of this implementation instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
    
    Specified by:
    
    ensureCapacity in interface IArray
    
    Parameters:
    
    size - the desired minimum capacity
  - copy
```
public ByteArrayList copy()
```
    Description copied from interface: ByteCollection
    
    A Function that does a shallow clone of the Collection itself. This function is more optimized then a copy constructor since the Collection does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
    
    Specified by:
    
    copy in interface ByteCollection
    
    Specified by:
    
    copy in interface ByteList
    
    Overrides:
    
    copy in class AbstractByteList
    
    Returns:
    
    a Shallow Copy of the collection
  - primitiveStream
```
public java.util.stream.IntStream primitiveStream()
```
    Returns a Java-Type-Specific Stream to reduce boxing/unboxing.
    
    Specified by:
    
    primitiveStream in interface ByteCollection
    
    Returns:
    
    a Stream of the closest java type
    
    Note:
    
    characteristics are ordered, sized, subsized
  - spliterator
```
public ByteSplititerator spliterator()
```
    A Type Specific Type Splititerator to reduce boxing/unboxing
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<java.lang.Byte>
    
    Specified by:
    
    spliterator in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    spliterator in interface java.util.List<java.lang.Byte>
    
    Specified by:
    
    spliterator in interface ByteCollection
    
    Specified by:
    
    spliterator in interface ByteIterable
    
    Specified by:
    
    spliterator in interface ByteList
    
    Returns:
    
    type specific splititerator
    
    Note:
    
    characteristics are ordered, sized, subsized

Class ByteArrayList

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.utils.ISizeProvider

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.bytes.lists.AbstractByteList

Methods inherited from class speiger.src.collections.bytes.collections.AbstractByteCollection

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.bytes.utils.IByteArray

Methods inherited from interface speiger.src.collections.utils.ITrimmable

Methods inherited from interface speiger.src.collections.bytes.collections.ByteStack

Methods inherited from interface speiger.src.collections.bytes.lists.ByteList

Methods inherited from interface speiger.src.collections.bytes.collections.ByteCollection

Methods inherited from interface speiger.src.collections.bytes.collections.ByteIterable

Methods inherited from interface speiger.src.collections.utils.ISizeProvider

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Constructor Detail

ByteArrayList

ByteArrayList

ByteArrayList

ByteArrayList

ByteArrayList

ByteArrayList

ByteArrayList

ByteArrayList

Method Detail

wrap

wrap

add

push

add

addAll

addAll

addAll

addAll

addElements

getElements

removeElements

extractElements

fillBuffer

contains

indexOf

lastIndexOf

contains

indexOf

lastIndexOf

sort

unstableSort

getByte

peek

elements

forEach

forEach

matchesAny

matchesNone

matchesAll

findFirst

reduce

reduce

count

set

replaceAll

replaceBytes

removeByte

swapRemove

remByte

pop

removeAll

retainAll

removeIf

removeAll

removeAll

retainAll

retainAll

remIf

toArray

toArray

toByteArray