TByteList (Trove 3.0.3)

All Superinterfaces:

TByteCollection

All Known Implementing Classes:

TByteArrayList, TByteLinkedList
```
public interface TByteList
extends TByteCollection
```
Interface for Trove list implementations.

Field Summary
- Fields inherited from interface gnu.trove.TByteCollection
  serialVersionUID

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`add(byte val)` Adds `val` to the end of the list, growing as needed.
`void`	`add(byte[] vals)` Adds the values in the array `vals` to the end of the list, in order.
`void`	`add(byte[] vals, int offset, int length)` Adds a subset of the values in the array `vals` to the end of the list, in order.
`int`	`binarySearch(byte value)` Performs a binary search for `value` in the entire list.
`int`	`binarySearch(byte value, int fromIndex, int toIndex)` Performs a binary search for `value` in the specified range.
`void`	`clear()` Flushes the internal state of the list, resetting the capacity to the default.
`boolean`	`contains(byte value)` Searches the list for `value`
`void`	`fill(byte val)` Fills every slot in the list with the specified value.
`void`	`fill(int fromIndex, int toIndex, byte val)` Fills a range in the list with the specified value.
`boolean`	`forEach(TByteProcedure procedure)` Applies the procedure to each value in the list in ascending (front to back) order.
`boolean`	`forEachDescending(TByteProcedure procedure)` Applies the procedure to each value in the list in descending (back to front) order.
`byte`	`get(int offset)` Returns the value at the specified offset.
`byte`	`getNoEntryValue()` Returns the value that is used to represent null.
`TByteList`	`grep(TByteProcedure condition)` Searches the list for values satisfying `condition` in the manner of the *nix `grep` utility.
`int`	`indexOf(byte value)` Searches the list front to back for the index of `value`.
`int`	`indexOf(int offset, byte value)` Searches the list front to back for the index of `value`, starting at `offset`.
`void`	`insert(int offset, byte value)` Inserts `value` into the list at `offset`.
`void`	`insert(int offset, byte[] values)` Inserts the array of `values` into the list at `offset`.
`void`	`insert(int offset, byte[] values, int valOffset, int len)` Inserts a slice of the array of `values` into the list at `offset`.
`TByteList`	`inverseGrep(TByteProcedure condition)` Searches the list for values which do not satisfy `condition`.
`boolean`	`isEmpty()` Tests whether this list contains any values.
`int`	`lastIndexOf(byte value)` Searches the list back to front for the last index of `value`.
`int`	`lastIndexOf(int offset, byte value)` Searches the list back to front for the last index of `value`, starting at `offset`.
`byte`	`max()` Finds the maximum value in the list.
`byte`	`min()` Finds the minimum value in the list.
`boolean`	`remove(byte value)` Removes `value` from the list.
`void`	`remove(int offset, int length)` Removes `length` values from the list, starting at `offset`
`byte`	`removeAt(int offset)` Removes `value` at a given offset from the list.
`byte`	`replace(int offset, byte val)` Sets the value at the specified offset and returns the previously stored value.
`void`	`reverse()` Reverse the order of the elements in the list.
`void`	`reverse(int from, int to)` Reverse the order of the elements in the range of the list.
`byte`	`set(int offset, byte val)` Sets the value at the specified offset.
`void`	`set(int offset, byte[] values)` Replace the values in the list starting at `offset` with the contents of the `values` array.
`void`	`set(int offset, byte[] values, int valOffset, int length)` Replace the values in the list starting at `offset` with `length` values from the `values` array, starting at valOffset.
`void`	`shuffle(java.util.Random rand)` Shuffle the elements of the list using the specified random number generator.
`int`	`size()` Returns the number of values in the list.
`void`	`sort()` Sort the values in the list (ascending) using the Sun quicksort implementation.
`void`	`sort(int fromIndex, int toIndex)` Sort a slice of the list (ascending) using the Sun quicksort implementation.
`TByteList`	`subList(int begin, int end)` Returns a sublist of this list.
`byte`	`sum()` Calculates the sum of all the values in the list.
`byte[]`	`toArray()` Copies the contents of the list into a native array.
`byte[]`	`toArray(byte[] dest)` Copies a slice of the list into a native array.
`byte[]`	`toArray(byte[] dest, int offset, int len)` Copies a slice of the list into a native array.
`byte[]`	`toArray(byte[] dest, int source_pos, int dest_pos, int len)` Copies a slice of the list into a native array.
`byte[]`	`toArray(int offset, int len)` Copies a slice of the list into a native array.
`void`	`transformValues(TByteFunction function)` Transform each value in the list using the specified function.

Methods inherited from interface gnu.trove.TByteCollection
addAll, addAll, addAll, containsAll, containsAll, containsAll, equals, hashCode, iterator, removeAll, removeAll, removeAll, retainAll, retainAll, retainAll

- Method Detail
  - getNoEntryValue
```
byte getNoEntryValue()
```
    Returns the value that is used to represent null. The default value is generally zero, but can be changed during construction of the collection.
    
    Specified by:
    
    getNoEntryValue in interface TByteCollection
    
    Returns:
    
    the value that represents null
  - size
```
int size()
```
    Returns the number of values in the list.
    
    Specified by:
    
    size in interface TByteCollection
    
    Returns:
    
    the number of values in the list.
  - isEmpty
```
boolean isEmpty()
```
    Tests whether this list contains any values.
    
    Specified by:
    
    isEmpty in interface TByteCollection
    
    Returns:
    
    true if the list is empty.
  - add
```
boolean add(byte val)
```
    Adds val to the end of the list, growing as needed.
    
    Specified by:
    
    add in interface TByteCollection
    
    Parameters:
    
    val - an byte value
    
    Returns:
    
    true if the list was modified by the add operation
  - add
```
void add(byte[] vals)
```
    Adds the values in the array vals to the end of the list, in order.
    
    Parameters:
    
    vals - an byte[] value
  - add
```
void add(byte[] vals,
         int offset,
         int length)
```
    Adds a subset of the values in the array vals to the end of the list, in order.
    
    Parameters:
    
    vals - an byte[] value
    
    offset - the offset at which to start copying
    
    length - the number of values to copy.
  - insert
```
void insert(int offset,
            byte value)
```
    Inserts value into the list at offset. All values including and to the right of offset are shifted to the right.
    
    Parameters:
    
    offset - an int value
    
    value - an byte value
  - insert
```
void insert(int offset,
            byte[] values)
```
    Inserts the array of values into the list at offset. All values including and to the right of offset are shifted to the right.
    
    Parameters:
    
    offset - an int value
    
    values - an byte[] value
  - insert
```
void insert(int offset,
            byte[] values,
            int valOffset,
            int len)
```
    Inserts a slice of the array of values into the list at offset. All values including and to the right of offset are shifted to the right.
    
    Parameters:
    
    offset - an int value
    
    values - an byte[] value
    
    valOffset - the offset in the values array at which to start copying.
    
    len - the number of values to copy from the values array
  - get
```
byte get(int offset)
```
    Returns the value at the specified offset.
    
    Parameters:
    
    offset - an int value
    
    Returns:
    
    an byte value
  - set
```
byte set(int offset,
         byte val)
```
    Sets the value at the specified offset.
    
    Parameters:
    
    offset - an int value
    
    val - an byte value
    
    Returns:
    
    The value previously at the given index.
  - set
```
void set(int offset,
         byte[] values)
```
    Replace the values in the list starting at offset with the contents of the values array.
    
    Parameters:
    
    offset - the first offset to replace
    
    values - the source of the new values
  - set
```
void set(int offset,
         byte[] values,
         int valOffset,
         int length)
```
    Replace the values in the list starting at offset with length values from the values array, starting at valOffset.
    
    Parameters:
    
    offset - the first offset to replace
    
    values - the source of the new values
    
    valOffset - the first value to copy from the values array
    
    length - the number of values to copy
  - replace
```
byte replace(int offset,
             byte val)
```
    Sets the value at the specified offset and returns the previously stored value.
    
    Parameters:
    
    offset - an int value
    
    val - an byte value
    
    Returns:
    
    the value previously stored at offset.
  - clear
```
void clear()
```
    Flushes the internal state of the list, resetting the capacity to the default.
    
    Specified by:
    
    clear in interface TByteCollection
  - remove
```
boolean remove(byte value)
```
    Removes value from the list.
    
    Specified by:
    
    remove in interface TByteCollection
    
    Parameters:
    
    value - an byte value
    
    Returns:
    
    true if the list was modified by the remove operation.
  - removeAt
```
byte removeAt(int offset)
```
    Removes value at a given offset from the list.
    
    Parameters:
    
    offset - an int value that represents the offset to the element to be removed
    
    Returns:
    
    an byte that is the value removed.
  - remove
```
void remove(int offset,
            int length)
```
    Removes length values from the list, starting at offset
    
    Parameters:
    
    offset - an int value
    
    length - an int value
  - transformValues
```
void transformValues(TByteFunction function)
```
    Transform each value in the list using the specified function.
    
    Parameters:
    
    function - a TByteFunction value
  - reverse
```
void reverse()
```
    Reverse the order of the elements in the list.
  - reverse
```
void reverse(int from,
             int to)
```
    Reverse the order of the elements in the range of the list.
    
    Parameters:
    
    from - the inclusive index at which to start reversing
    
    to - the exclusive index at which to stop reversing
  - shuffle
```
void shuffle(java.util.Random rand)
```
    Shuffle the elements of the list using the specified random number generator.
    
    Parameters:
    
    rand - a Random value
  - subList
```
TByteList subList(int begin,
                  int end)
```
    Returns a sublist of this list.
    
    Parameters:
    
    begin - low endpoint (inclusive) of the subList.
    
    end - high endpoint (exclusive) of the subList.
    
    Returns:
    
    sublist of this list from begin, inclusive to end, exclusive.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - - endpoint out of range
    
    java.lang.IllegalArgumentException - - endpoints out of order (end > begin)
  - toArray
```
byte[] toArray()
```
    Copies the contents of the list into a native array.
    
    Specified by:
    
    toArray in interface TByteCollection
    
    Returns:
    
    an byte[] value
  - toArray
```
byte[] toArray(int offset,
               int len)
```
    Copies a slice of the list into a native array.
    
    Parameters:
    
    offset - the offset at which to start copying
    
    len - the number of values to copy.
    
    Returns:
    
    an byte[] value
  - toArray
```
byte[] toArray(byte[] dest)
```
    Copies a slice of the list into a native array.
    If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the list is set to getNoEntryValue(). (This is useful in determining the length of the list only if the caller knows that the list does not contain any "null" elements.)
    NOTE: Trove does not allocate a new array if the array passed in is not large enough to hold all of the data elements. It will instead fill the array passed in.
    
    Specified by:
    
    toArray in interface TByteCollection
    
    Parameters:
    
    dest - the array to copy into.
    
    Returns:
    
    the array passed in.
  - toArray
```
byte[] toArray(byte[] dest,
               int offset,
               int len)
```
    Copies a slice of the list into a native array.
    
    Parameters:
    
    dest - the array to copy into.
    
    offset - the offset where the first value should be copied
    
    len - the number of values to copy.
    
    Returns:
    
    the array passed in.
  - toArray
```
byte[] toArray(byte[] dest,
               int source_pos,
               int dest_pos,
               int len)
```
    Copies a slice of the list into a native array.
    
    Parameters:
    
    dest - the array to copy into.
    
    source_pos - the offset of the first value to copy
    
    dest_pos - the offset where the first value should be copied
    
    len - the number of values to copy.
    
    Returns:
    
    the array passed in.
  - forEach
```
boolean forEach(TByteProcedure procedure)
```
    Applies the procedure to each value in the list in ascending (front to back) order.
    
    Specified by:
    
    forEach in interface TByteCollection
    
    Parameters:
    
    procedure - a TByteProcedure value
    
    Returns:
    
    true if the procedure did not terminate prematurely.
  - forEachDescending
```
boolean forEachDescending(TByteProcedure procedure)
```
    Applies the procedure to each value in the list in descending (back to front) order.
    
    Parameters:
    
    procedure - a TByteProcedure value
    
    Returns:
    
    true if the procedure did not terminate prematurely.
  - sort
```
void sort()
```
    Sort the values in the list (ascending) using the Sun quicksort implementation.
    
    See Also:
    
    Arrays.sort(int[])
  - sort
```
void sort(int fromIndex,
          int toIndex)
```
    Sort a slice of the list (ascending) using the Sun quicksort implementation.
    
    Parameters:
    
    fromIndex - the index at which to start sorting (inclusive)
    
    toIndex - the index at which to stop sorting (exclusive)
    
    See Also:
    
    Arrays.sort(int[])
  - fill
```
void fill(byte val)
```
    Fills every slot in the list with the specified value.
    
    Parameters:
    
    val - the value to use when filling
  - fill
```
void fill(int fromIndex,
          int toIndex,
          byte val)
```
    Fills a range in the list with the specified value.
    
    Parameters:
    
    fromIndex - the offset at which to start filling (inclusive)
    
    toIndex - the offset at which to stop filling (exclusive)
    
    val - the value to use when filling
  - binarySearch
```
int binarySearch(byte value)
```
    Performs a binary search for value in the entire list. Note that you must @{link #sort sort} the list before doing a search.
    
    Parameters:
    
    value - the value to search for
    
    Returns:
    
    the absolute offset in the list of the value, or its negative insertion point into the sorted list.
  - binarySearch
```
int binarySearch(byte value,
                 int fromIndex,
                 int toIndex)
```
    Performs a binary search for value in the specified range. Note that you must @{link #sort sort} the list or the range before doing a search.
    
    Parameters:
    
    value - the value to search for
    
    fromIndex - the lower boundary of the range (inclusive)
    
    toIndex - the upper boundary of the range (exclusive)
    
    Returns:
    
    the absolute offset in the list of the value, or its negative insertion point into the sorted list.
  - indexOf
```
int indexOf(byte value)
```
    Searches the list front to back for the index of value.
    
    Parameters:
    
    value - an byte value
    
    Returns:
    
    the first offset of the value, or -1 if it is not in the list.
    
    See Also:
    
    for faster searches on sorted lists
  - indexOf
```
int indexOf(int offset,
            byte value)
```
    Searches the list front to back for the index of value, starting at offset.
    
    Parameters:
    
    offset - the offset at which to start the linear search (inclusive)
    
    value - an byte value
    
    Returns:
    
    the first offset of the value, or -1 if it is not in the list.
    
    See Also:
    
    for faster searches on sorted lists
  - lastIndexOf
```
int lastIndexOf(byte value)
```
    Searches the list back to front for the last index of value.
    
    Parameters:
    
    value - an byte value
    
    Returns:
    
    the last offset of the value, or -1 if it is not in the list.
    
    See Also:
    
    for faster searches on sorted lists
  - lastIndexOf
```
int lastIndexOf(int offset,
                byte value)
```
    Searches the list back to front for the last index of value, starting at offset.
    
    Parameters:
    
    offset - the offset at which to start the linear search (exclusive)
    
    value - an byte value
    
    Returns:
    
    the last offset of the value, or -1 if it is not in the list.
    
    See Also:
    
    for faster searches on sorted lists
  - contains
```
boolean contains(byte value)
```
    Searches the list for value
    
    Specified by:
    
    contains in interface TByteCollection
    
    Parameters:
    
    value - an byte value
    
    Returns:
    
    true if value is in the list.
  - grep
```
TByteList grep(TByteProcedure condition)
```
    Searches the list for values satisfying condition in the manner of the *nix grep utility.
    
    Parameters:
    
    condition - a condition to apply to each element in the list
    
    Returns:
    
    a list of values which match the condition.
  - inverseGrep
```
TByteList inverseGrep(TByteProcedure condition)
```
    Searches the list for values which do not satisfy condition. This is akin to *nix grep -v.
    
    Parameters:
    
    condition - a condition to apply to each element in the list
    
    Returns:
    
    a list of values which do not match the condition.
  - max
```
byte max()
```
    Finds the maximum value in the list.
    
    Returns:
    
    the largest value in the list.
    
    Throws:
    
    java.lang.IllegalStateException - if the list is empty
  - min
```
byte min()
```
    Finds the minimum value in the list.
    
    Returns:
    
    the smallest value in the list.
    
    Throws:
    
    java.lang.IllegalStateException - if the list is empty
  - sum
```
byte sum()
```
    Calculates the sum of all the values in the list.
    
    Returns:
    
    the sum of the values in the list (zero if the list is empty).

Interface TByteList

Field Summary

Fields inherited from interface gnu.trove.TByteCollection

Method Summary

Methods inherited from interface gnu.trove.TByteCollection

Method Detail

getNoEntryValue

size

isEmpty

add

add

add

insert

insert

insert

get

set

set

set

replace

clear

remove

removeAt

remove

transformValues

reverse

reverse

shuffle

subList

toArray

toArray

toArray

toArray

toArray

forEach

forEachDescending

sort

sort

fill

fill

binarySearch

binarySearch

indexOf

indexOf

lastIndexOf

lastIndexOf

contains

grep

inverseGrep

max

min

sum