ByteList (LibJ Util 0.8.1 API)

All Superinterfaces:

ByteCollection, ByteIterable, Cloneable, PrimitiveCollection, Serializable

All Known Implementing Classes:

ArrayByteList
```
@Generated(value="Autogenerated by OpenJAX CodeGen Template (0.2.5)",
           date="2020-05-23")
public interface ByteList
extends ByteCollection
```
An ordered collection (also known as a sequence), of byte values.
This interface is a replica of the List interface that defines synonymous methods for a list of byte values instead of Object references.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`add(byte value)` Appends the specified value to the end of this list.
`boolean`	`add(int index, byte value)` Inserts the specified value at the specified position in this list.
`default boolean`	`addAll(byte... values)` Appends all of the values in the specified array to the end of this list, in the order that they appear in the array.
`boolean`	`addAll(byte[] values, int offset, int length)` Appends all of the values in the specified array to the end of this list, in the order that they appear in the array.
`boolean`	`addAll(ByteCollection c)` Appends all of the values in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator.
`boolean`	`addAll(Collection<Byte> c)` Appends all of the values in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator.
`default boolean`	`addAll(int index, byte[] values)` Appends all of the values in the specified array to the end of this list, in the order that they appear in the array.
`boolean`	`addAll(int index, byte[] values, int offset, int length)` Appends all of the values in the specified array to the end of this list, in the order that they appear in the array.
`boolean`	`addAll(int index, ByteCollection c)` Appends all of the values in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator.
`boolean`	`addAll(int index, Collection<Byte> c)` Appends all of the values in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator.
`void`	`clear()` Removes all of the elements from this list.
`default boolean`	`contains(byte value)` Returns `true` if this list contains the specified value.
`default boolean`	`containsAll(byte... values)` Returns `true` if this collection contains all of the values in the specified array.
`boolean`	`equals(Object obj)` Compares the specified object with this list for equality.
`byte`	`get(int index)` Returns the value at the specified position in this list.
`int`	`hashCode()` Returns the hash code value for this list.
`int`	`indexOf(byte value)` Returns the index of the first occurrence of the specified value in this list, or -1 if this list does not contain the value.
`boolean`	`isEmpty()` Returns `true` if this list contains no values.
`ByteIterator`	`iterator()` Returns an iterator over the values in this list in proper sequence.
`int`	`lastIndexOf(byte value)` Returns the index of the last occurrence of the specified value in this list, or -1 if this list does not contain the value.
`default ByteListIterator`	`listIterator()` Returns a byte list iterator over the values in this list (in proper sequence).
`ByteListIterator`	`listIterator(int index)` Returns a byte list iterator over the values in this list (in proper sequence), starting at the specified position in the list.
`default byte`	`peek()` Looks at the value at the top of this list without removing it from the list.
`default byte`	`pop()` Removes the value at the top of this list and returns that value.
`default byte`	`push(byte value)` Pushes an item onto the top of this list.
`default boolean`	`remove(byte value)` Removes the first occurrence of the specified value from this list, if it is present.
`default boolean`	`removeAll(byte... values)` Removes from this list all of its values that are contained in the specified array.
`default boolean`	`removeAll(ByteCollection c)` Removes from this list all of its values that are contained in the specified collection.
`default boolean`	`removeAll(Collection<Byte> c)` Removes from this list all of its values that are contained in the specified `Collection`.
`byte`	`removeIndex(int index)` Removes the value at the specified index in this list.
`default void`	`replaceAll(ByteUnaryOperator operator)` Replaces each value of this list with the result of applying the operator to that value.
`boolean`	`retainAll(ByteCollection c)` Retains only the values in this list that are contained in the specified collection.
`boolean`	`retainAll(Collection<Byte> c)` Retains only the values in this list that are contained in the specified collection.
`byte`	`set(int index, byte value)` Replaces the value at the specified position in this list with the specified value.
`int`	`size()` Returns the number of values in this list.
`default void`	`sort()` Sorts the list into ascending order.
`void`	`sort(ByteComparator c)` Sorts the specified list according to the order induced by the specified comparator.
`default void`	`sort(List<?> p)` Sorts the specified paired list according to the order induced by the specified comparator applied to the values in this list.
`default void`	`sort(List<?> p, ByteComparator c)` Sorts the specified paired list according to the order induced by the specified comparator applied to the values in this list.
`default void`	`sort(Object[] p)` Sorts the specified paired array according to the order induced by the specified comparator applied to the values in this list.
`default void`	`sort(Object[] p, ByteComparator c)` Sorts this specified paired array according to the order induced by the specified comparator applied to the values in this list.
`ByteList`	`subList(int fromIndex, int toIndex)` Returns a view of the portion of this list between the specified `fromIndex`, inclusive, and `toIndex`, exclusive.

Methods inherited from interface org.libj.util.primitive.ByteCollection
containsAll, containsAll, removeIf, toArray, toArray, toArray

- Method Detail
  - push
```
default byte push(byte value)
```
    Pushes an item onto the top of this list. This has exactly the same effect as:
```
  add(value)
 
```
    Parameters:
    
    value - The value to be pushed onto this list.
    
    Returns:
    
    The value argument.
    
    See Also:
    
    add(byte)
  - pop
```
default byte pop()
```
    Removes the value at the top of this list and returns that value. This has exactly the same effect as:
```
  removeIndex(size() - 1)
 
```
    Returns:
    
    The value at the top of this list (the last item of the ByteList object).
    
    Throws:
    
    IndexOutOfBoundsException - If this list is empty.
  - peek
```
default byte peek()
```
    Looks at the value at the top of this list without removing it from the list. This has exactly the same effect as:
```
  get(size() - 1)
 
```
    Returns:
    
    The value at the top of this list (the last item of the ByteList object).
    
    Throws:
    
    IndexOutOfBoundsException - If this list is empty.
  - get
```
byte get(int index)
```
    Returns the value at the specified position in this list.
    
    Parameters:
    
    index - Index of the value to return.
    
    Returns:
    
    The value at the specified position in this list.
    
    Throws:
    
    IndexOutOfBoundsException - If the index is out of range (index < 0 || size() < index).
  - add
```
boolean add(byte value)
```
    Appends the specified value to the end of this list.
    
    Specified by:
    
    add in interface ByteCollection
    
    Parameters:
    
    value - Value to be appended to this list.
    
    Returns:
    
    true if this list changed as a result of the call.
  - add
```
boolean add(int index,
            byte value)
```
    Inserts the specified value at the specified position in this list. Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices).
    
    Parameters:
    
    index - Index at which the specified value is to be inserted
    
    value - Value to be inserted.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    IndexOutOfBoundsException - If the index is out of range (index < 0 || size() < index).
  - addAll
```
boolean addAll(int index,
               byte[] values,
               int offset,
               int length)
```
    Appends all of the values in the specified array to the end of this list, in the order that they appear in the array.
    
    Parameters:
    
    index - Index at which to insert the first value from the specified array.
    
    values - Array containing values to be added to this list.
    
    offset - The index of the first value to add.
    
    length - The number of values to add.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    IndexOutOfBoundsException - If the index is out of range (index < 0 || size() < index), or if the offset or length are out of range (offset < 0 || values.length < offset + length).
    
    NullPointerException - If the specified array is null.
  - addAll
```
default boolean addAll(int index,
                       byte[] values)
```
    Appends all of the values in the specified array to the end of this list, in the order that they appear in the array.
    
    Parameters:
    
    index - Index at which to insert the first value from the specified array.
    
    values - Array containing values to be added to this list.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    IndexOutOfBoundsException - If the index is out of range (index < 0 || size() < index).
    
    NullPointerException - If the specified array is null.
  - addAll
```
boolean addAll(byte[] values,
               int offset,
               int length)
```
    Appends all of the values in the specified array to the end of this list, in the order that they appear in the array.
    
    Parameters:
    
    values - Array containing values to be added to this list.
    
    offset - The index of the first value to add.
    
    length - The number of values to add.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    IndexOutOfBoundsException - If the offset or length are out of range (offset < 0 || values.length < offset + length).
    
    NullPointerException - If the specified array is null.
  - addAll
```
default boolean addAll(byte... values)
```
    Appends all of the values in the specified array to the end of this list, in the order that they appear in the array.
    
    Specified by:
    
    addAll in interface ByteCollection
    
    Parameters:
    
    values - Array containing values to be added to this list.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    NullPointerException - If the specified array is null.
  - addAll
```
boolean addAll(int index,
               Collection<Byte> c)
```
    Appends all of the values in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator.
    
    Parameters:
    
    index - Index at which to insert the first value from the specified collection.
    
    c - Collection containing values to be added to this list.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    IndexOutOfBoundsException - If the index is out of range (index < 0 || size() < index).
    
    ClassCastException - If the class of an element of the specified collection is not Byte.
    
    NullPointerException - If the specified collection is null, or if the collection contains a null element.
  - addAll
```
boolean addAll(Collection<Byte> c)
```
    Appends all of the values in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator.
    
    Specified by:
    
    addAll in interface ByteCollection
    
    Parameters:
    
    c - Collection containing values to be added to this list.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    ClassCastException - If the class of an element of the specified collection is not Byte.
    
    NullPointerException - If the specified collection is null, or if the collection contains a null element.
  - addAll
```
boolean addAll(int index,
               ByteCollection c)
```
    Appends all of the values in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
    
    Parameters:
    
    index - Index at which to insert the first value from the specified collection.
    
    c - Collection containing values to be added to this list.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    IndexOutOfBoundsException - If the index is out of range (index < 0 || size() < index).
    
    NullPointerException - If the specified collection is null.
  - addAll
```
boolean addAll(ByteCollection c)
```
    Appends all of the values in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
    
    Specified by:
    
    addAll in interface ByteCollection
    
    Parameters:
    
    c - Collection containing values to be added to this list.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    NullPointerException - If the specified collection is null.
  - set
```
byte set(int index,
         byte value)
```
    Replaces the value at the specified position in this list with the specified value.
    
    Parameters:
    
    index - Index of the value to replace.
    
    value - Value to be stored at the specified position.
    
    Returns:
    
    The value previously at the specified position.
    
    Throws:
    
    IndexOutOfBoundsException - If the index is out of range (index < 0 || size() < index).
  - removeIndex
```
byte removeIndex(int index)
```
    Removes the value at the specified index in this list. Shifts any subsequent values to the left (subtracts one from their indices).
    
    Parameters:
    
    index - The index of the value to be removed.
    
    Returns:
    
    The value that was removed from the list.
    
    Throws:
    
    IndexOutOfBoundsException - If the index is out of range (index < 0 || size() < index).
  - remove
```
default boolean remove(byte value)
```
    Removes the first occurrence of the specified value from this list, if it is present. If the list does not contain the value, it is unchanged. More formally, removes the value with the lowest index i such that Objects.equals(o, get(i)) (if such an value exists). Returns true if this list contained the specified value (or equivalently, if this list changed as a result of the call).
    
    Specified by:
    
    remove in interface ByteCollection
    
    Parameters:
    
    value - Value to be removed from this list, if present.
    
    Returns:
    
    true if this list contained the specified value.
  - removeAll
```
default boolean removeAll(byte... values)
```
    Removes from this list all of its values that are contained in the specified array.
    
    Specified by:
    
    removeAll in interface ByteCollection
    
    Parameters:
    
    values - Values to be removed from this list.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    See Also:
    
    remove(byte), contains(byte)
  - removeAll
```
default boolean removeAll(ByteCollection c)
```
    Removes from this list all of its values that are contained in the specified collection.
    
    Specified by:
    
    removeAll in interface ByteCollection
    
    Parameters:
    
    c - Collection containing values to be removed from this list.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    NullPointerException - If the specified collection is null.
    
    See Also:
    
    remove(byte), contains(byte)
  - removeAll
```
default boolean removeAll(Collection<Byte> c)
```
    Removes from this list all of its values that are contained in the specified Collection.
    
    Specified by:
    
    removeAll in interface ByteCollection
    
    Parameters:
    
    c - Collection containing values to be removed from this list.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    ClassCastException - If the class of an element of the specified collection is not Byte.
    
    NullPointerException - If the specified collection is null, or if the collection contains a null element.
    
    See Also:
    
    remove(byte), contains(byte)
  - retainAll
```
boolean retainAll(Collection<Byte> c)
```
    Retains only the values in this list that are contained in the specified collection. In other words, removes from this list all of its values that are not contained in the specified collection.
    
    Specified by:
    
    retainAll in interface ByteCollection
    
    Parameters:
    
    c - Collection containing values to be retained in this list.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    ClassCastException - If the class of an element of the specified collection is not Byte.
    
    NullPointerException - If the specified collection contains a null value, or if the specified collection is null.
    
    See Also:
    
    remove(byte), contains(byte)
  - retainAll
```
boolean retainAll(ByteCollection c)
```
    Retains only the values in this list that are contained in the specified collection. In other words, removes from this list all of its values that are not contained in the specified collection.
    
    Specified by:
    
    retainAll in interface ByteCollection
    
    Parameters:
    
    c - Collection containing values to be retained in this list.
    
    Returns:
    
    true if this list changed as a result of the call.
    
    Throws:
    
    NullPointerException - If the specified collection contains a null value, or if the specified collection is null.
    
    See Also:
    
    remove(byte), contains(byte)
  - replaceAll
```
default void replaceAll(ByteUnaryOperator operator)
```
    Replaces each value of this list with the result of applying the operator to that value. Errors or runtime exceptions thrown by the operator are relayed to the caller.
    If the list's list-iterator does not support the set operation, then an UnsupportedOperationException will be thrown when replacing the first value.
    
    Parameters:
    
    operator - The operator to apply to each value.
    
    Throws:
    
    NullPointerException - If the specified operator is null.
  - contains
```
default boolean contains(byte value)
```
    Returns true if this list contains the specified value. More formally, returns true if and only if this list contains at least one value v such that Objects.equals(o, e).
    
    Specified by:
    
    contains in interface ByteCollection
    
    Parameters:
    
    value - Value whose presence in this list is to be tested.
    
    Returns:
    
    true if this list contains the specified value.
  - containsAll
```
default boolean containsAll(byte... values)
```
    Returns true if this collection contains all of the values in the specified array.
    
    Parameters:
    
    values - Array to be checked for containment in this collection.
    
    Returns:
    
    true if this collection contains all of the values in the specified collection.
    
    See Also:
    
    contains(byte)
  - indexOf
```
int indexOf(byte value)
```
    Returns the index of the first occurrence of the specified value in this list, or -1 if this list does not contain the value. More formally, returns the lowest index i such that value == get(i), or -1 if there is no such value.
    
    Parameters:
    
    value - Value to search for.
    
    Returns:
    
    The index of the first occurrence of the specified value in this list, or -1 if this list does not contain the value.
  - lastIndexOf
```
int lastIndexOf(byte value)
```
    Returns the index of the last occurrence of the specified value in this list, or -1 if this list does not contain the value. More formally, returns the highest index i such that value == get(i), or -1 if there is no such value.
    
    Parameters:
    
    value - Value to search for.
    
    Returns:
    
    The index of the last occurrence of the specified value in this list, or -1 if this list does not contain the value.
  - iterator
```
ByteIterator iterator()
```
    Returns an iterator over the values in this list in proper sequence.
    
    Specified by:
    
    iterator in interface ByteIterable
    
    Returns:
    
    An iterator over the values in this list in proper sequence.
  - listIterator
```
default ByteListIterator listIterator()
```
    Returns a byte list iterator over the values in this list (in proper sequence).
    
    Returns:
    
    An byte list iterator over the values in this list (in proper sequence).
  - listIterator
```
ByteListIterator listIterator(int index)
```
    Returns a byte list iterator over the values in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first value that would be returned by an initial call to next. An initial call to previous would return the value with the specified index minus one.
    
    Parameters:
    
    index - Index of the first value to be returned from the byte list iterator (by a call to next).
    
    Returns:
    
    A byte list iterator over the values in this list (in proper sequence), starting at the specified position in the list.
    
    Throws:
    
    IndexOutOfBoundsException - If the index is out of range (index < 0 || index > size()).
  - size
```
int size()
```
    Returns the number of values in this list. If this list contains more than Byte.MAX_VALUE values, returns Byte.MAX_VALUE.
    
    Specified by:
    
    size in interface PrimitiveCollection
    
    Returns:
    
    The number of values in this list.
  - isEmpty
```
boolean isEmpty()
```
    Returns true if this list contains no values.
    
    Specified by:
    
    isEmpty in interface PrimitiveCollection
    
    Returns:
    
    true if this list contains no values.
  - sort
```
default void sort()
```
    Sorts the list into ascending order.
  - sort
```
void sort(ByteComparator c)
```
    Sorts the specified list according to the order induced by the specified comparator.
    
    Parameters:
    
    c - The comparator to determine the order of the list.
  - sort
```
default void sort(Object[] p)
```
    Sorts the specified paired array according to the order induced by the specified comparator applied to the values in this list.
    This method will result in this and the specified paired list to be sorted in tandem.
    For example, this and p are initialized to:
```
 this: 6 8 9 7 4 0 2 3 1 5
    p: g i j h e a c d b f
 
```
    After sort(p) is called:
```
 this: 0 1 2 3 4 5 6 7 8 9
    p: a b c d e f g h i j
 
```
    Parameters:
    
    p - The paired array that is to be sorted in tandem with this list.
  - sort
```
default void sort(Object[] p,
                  ByteComparator c)
```
    Sorts this specified paired array according to the order induced by the specified comparator applied to the values in this list.
    This method will result in this and the specified paired list to be sorted in tandem.
    For example, this and p are initialized to:
```
 this: 6 8 9 7 4 0 2 3 1 5
    p: g i j h e a c d b f
 
```
    After sort(p) is called:
```
 this: 0 1 2 3 4 5 6 7 8 9
    p: a b c d e f g h i j
 
```
    Parameters:
    
    p - The paired array that is to be sorted in tandem with this list.
    
    c - The comparator to determine the order of this and the paired array.
    
    Throws:
    
    IllegalArgumentException - If the length of the paired list does not match that of this list.
  - sort
```
default void sort(List<?> p)
```
    Sorts the specified paired list according to the order induced by the specified comparator applied to the values in this list.
    This method will result in this and the specified paired list to be sorted in tandem.
    
    Parameters:
    
    p - The paired list that is to be sorted in tandem with this list.
  - sort
```
default void sort(List<?> p,
                  ByteComparator c)
```
    Sorts the specified paired list according to the order induced by the specified comparator applied to the values in this list.
    This method will result in this and the specified paired list to be sorted in tandem.
    
    Parameters:
    
    p - The paired list that is to be sorted in tandem with this list.
    
    c - The comparator to determine the order of this and the paired list.
    
    Throws:
    
    IllegalArgumentException - If the length of the paired list does not match that of this list.
  - clear
```
void clear()
```
    Removes all of the elements from this list. The list will be empty after this call returns.
    
    Specified by:
    
    clear in interface PrimitiveCollection
  - subList
```
ByteList subList(int fromIndex,
                 int toIndex)
```
    Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty). The returned list is backed by this list, so non-structural, or structural, changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.
    This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:
```
  list.subList(from, to).clear();
 
```
    Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the ByteList class can be applied to a subList.
    The semantics of the list returned by this method are defined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. Structural modifications are those that change the size of this list.
    - Changes made to the returned sub-list will be reflected in its parent list.
      
      If a value is added to the sub-list, the value addition will be reflected at the relevant index of the parent list, and the range and size of the sub-list and its parent list will increase by 1.
      
      If a value is removed from the sub-list, the value removal will be reflected at the relevant index of the parent list, and the range and size of the sub-list and its parent list will reduce by 1.
    - Changes made to the parent list will be reflected in the returned sub-list.
      
      If a value is added to the parent list in the range of the sub-list, the value addition will be reflected at the relevant index of the sub-list, and the range and size of the parent list and the sub-list will increase by 1.
      
      If a value is added to the parent list in the range preceding the fromIndex of the sub-list, the range indexes of the sub-list will increase by 1.
      
      If a value is removed from the parent list in the range of the sub-list, the value removal will be reflected at the relevant index of the sub-list, and the range and size of the parent list and the sub-list will reduce by 1.
      
      If a value is removed from the parent list in the range preceding the fromIndex of the sub-list, the range indexes of the sub-list will reduce by 1.
    Parameters:
    
    fromIndex - Low endpoint (inclusive) of the subList.
    
    toIndex - High endpoint (exclusive) of the subList.
    
    Returns:
    
    A view of the specified range within this list.
    
    Throws:
    
    IndexOutOfBoundsException - For range parameters that are out-of-bounds (fromIndex < 0 || toIndex > size || fromIndex > toIndex).
  - equals
```
boolean equals(Object obj)
```
    Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both lists have the same size, and all corresponding pairs of values in the two lists are equal. (Two values v1 and v2 are equal if v1 == v2.) In other words, two lists are defined to be equal if they contain the same values in the same order.
    
    Specified by:
    
    equals in interface PrimitiveCollection
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - The object to be compared for equality with this list.
    
    Returns:
    
    true if the specified object is equal to this list.
    
    See Also:
    
    Object.equals(Object), IntSet.equals(Object), IntList.equals(Object)
  - hashCode
```
int hashCode()
```
    Returns the hash code value for this list. The hash code algorithm of a list is defined in List.hashCode().
    
    Specified by:
    
    hashCode in interface PrimitiveCollection
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    The hash code value for this list.
    
    See Also:
    
    Object.equals(Object), equals(Object)

Interface ByteList

Method Summary

Methods inherited from interface org.libj.util.primitive.ByteCollection

Method Detail

push

pop

peek

get

add

add

addAll

addAll

addAll

addAll

addAll

addAll

addAll

addAll

set

removeIndex

remove

removeAll

removeAll

removeAll

retainAll

retainAll

replaceAll

contains

containsAll

indexOf

lastIndexOf

iterator

listIterator

listIterator

size

isEmpty

sort

sort

sort

sort

sort

sort

clear

subList

equals

hashCode