TUnmodifiableCharList

java.lang.Object
- gnu.trove.impl.unmodifiable.TUnmodifiableCharCollection
- - gnu.trove.impl.unmodifiable.TUnmodifiableCharList

All Implemented Interfaces:

TCharList, TCharCollection, Serializable

Direct Known Subclasses:

TUnmodifiableRandomAccessCharList
```
public class TUnmodifiableCharList
extends TUnmodifiableCharCollection
implements TCharList
```
See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
`TUnmodifiableCharList(TCharList list)`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`void`	`add(char[] vals)` Adds the values in the array `vals` to the end of the list, in order.
`void`	`add(char[] 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(char value)` Performs a binary search for `value` in the entire list.
`int`	`binarySearch(char value, int fromIndex, int toIndex)` Performs a binary search for `value` in the specified range.
`boolean`	`equals(Object o)` Compares the specified object with this collection for equality.
`void`	`fill(char val)` Fills every slot in the list with the specified value.
`void`	`fill(int fromIndex, int toIndex, char val)` Fills a range in the list with the specified value.
`boolean`	`forEachDescending(TCharProcedure procedure)` Applies the procedure to each value in the list in descending (back to front) order.
`char`	`get(int index)` Returns the value at the specified offset.
`TCharList`	`grep(TCharProcedure condition)` Searches the list for values satisfying `condition` in the manner of the *nix `grep` utility.
`int`	`hashCode()` Returns the hash code value for this collection.
`int`	`indexOf(char o)` Searches the list front to back for the index of `value`.
`int`	`indexOf(int offset, char value)` Searches the list front to back for the index of `value`, starting at `offset`.
`void`	`insert(int offset, char value)` Inserts `value` into the list at `offset`.
`void`	`insert(int offset, char[] values)` Inserts the array of `values` into the list at `offset`.
`void`	`insert(int offset, char[] values, int valOffset, int len)` Inserts a slice of the array of `values` into the list at `offset`.
`TCharList`	`inverseGrep(TCharProcedure condition)` Searches the list for values which do not satisfy `condition`.
`int`	`lastIndexOf(char o)` Searches the list back to front for the last index of `value`.
`int`	`lastIndexOf(int offset, char value)` Searches the list back to front for the last index of `value`, starting at `offset`.
`char`	`max()` Finds the maximum value in the list.
`char`	`min()` Finds the minimum value in the list.
`void`	`remove(int offset, int length)` Removes `length` values from the list, starting at `offset`
`char`	`removeAt(int offset)` Removes `value` at a given offset from the list.
`char`	`replace(int offset, char 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.
`char`	`set(int offset, char val)` Sets the value at the specified offset.
`void`	`set(int offset, char[] values)` Replace the values in the list starting at `offset` with the contents of the `values` array.
`void`	`set(int offset, char[] 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(Random rand)` Shuffle the elements of the list using the specified random number generator.
`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.
`TCharList`	`subList(int fromIndex, int toIndex)` Returns a sublist of this list.
`char`	`sum()` Calculates the sum of all the values in the list.
`char[]`	`toArray(char[] dest, int offset, int len)` Copies a slice of the list into a native array.
`char[]`	`toArray(char[] dest, int source_pos, int dest_pos, int len)` Copies a slice of the list into a native array.
`char[]`	`toArray(int offset, int len)` Copies a slice of the list into a native array.
`void`	`transformValues(TCharFunction function)` Transform each value in the list using the specified function.

Methods inherited from class gnu.trove.impl.unmodifiable.TUnmodifiableCharCollection
add, addAll, addAll, addAll, clear, contains, containsAll, containsAll, containsAll, forEach, getNoEntryValue, isEmpty, iterator, remove, removeAll, removeAll, removeAll, retainAll, retainAll, retainAll, size, toArray, toArray, toString

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

Methods inherited from interface gnu.trove.list.TCharList
add, clear, contains, forEach, getNoEntryValue, isEmpty, remove, size, toArray, toArray

Methods inherited from interface gnu.trove.TCharCollection
addAll, addAll, addAll, containsAll, containsAll, containsAll, iterator, removeAll, removeAll, removeAll, retainAll, retainAll, retainAll

- Constructor Detail
  - TUnmodifiableCharList
```
public TUnmodifiableCharList(TCharList list)
```
- Method Detail
  - equals
```
public boolean equals(Object o)
```
    Description copied from interface: TCharCollection
    
    Compares the specified object with this collection for equality. Returns true if the specified object is also a collection, the two collection have the same size, and every member of the specified collection is contained in this collection (or equivalently, every member of this collection is contained in the specified collection). This definition ensures that the equals method works properly across different implementations of the collection interface.
    
    Specified by:
    
    equals in interface TCharCollection
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - object to be compared for equality with this collection
    
    Returns:
    
    true if the specified object is equal to this collection
  - hashCode
```
public int hashCode()
```
    Description copied from interface: TCharCollection
    
    Returns the hash code value for this collection. The hash code of a collection is defined to be the sum of the hash codes of the elements in the collection. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two collection s1 and s2, as required by the general contract of Object.hashCode().
    
    Specified by:
    
    hashCode in interface TCharCollection
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code value for this collection
    
    See Also:
    
    Object.equals(Object), Collection.equals(Object)
  - get
```
public char get(int index)
```
    Description copied from interface: TCharList
    
    Returns the value at the specified offset.
    
    Specified by:
    
    get in interface TCharList
    
    Parameters:
    
    index - an int value
    
    Returns:
    
    an char value
  - indexOf
```
public int indexOf(char o)
```
    Description copied from interface: TCharList
    
    Searches the list front to back for the index of value.
    
    Specified by:
    
    indexOf in interface TCharList
    
    Parameters:
    
    o - an char 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
```
public int lastIndexOf(char o)
```
    Description copied from interface: TCharList
    
    Searches the list back to front for the last index of value.
    
    Specified by:
    
    lastIndexOf in interface TCharList
    
    Parameters:
    
    o - an char 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
  - toArray
```
public char[] toArray(int offset,
                      int len)
```
    Description copied from interface: TCharList
    
    Copies a slice of the list into a native array.
    
    Specified by:
    
    toArray in interface TCharList
    
    Parameters:
    
    offset - the offset at which to start copying
    
    len - the number of values to copy.
    
    Returns:
    
    an char[] value
  - toArray
```
public char[] toArray(char[] dest,
                      int offset,
                      int len)
```
    Description copied from interface: TCharList
    
    Copies a slice of the list into a native array.
    
    Specified by:
    
    toArray in interface TCharList
    
    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
```
public char[] toArray(char[] dest,
                      int source_pos,
                      int dest_pos,
                      int len)
```
    Description copied from interface: TCharList
    
    Copies a slice of the list into a native array.
    
    Specified by:
    
    toArray in interface TCharList
    
    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.
  - forEachDescending
```
public boolean forEachDescending(TCharProcedure procedure)
```
    Description copied from interface: TCharList
    
    Applies the procedure to each value in the list in descending (back to front) order.
    
    Specified by:
    
    forEachDescending in interface TCharList
    
    Parameters:
    
    procedure - a TCharProcedure value
    
    Returns:
    
    true if the procedure did not terminate prematurely.
  - binarySearch
```
public int binarySearch(char value)
```
    Description copied from interface: TCharList
    
    Performs a binary search for value in the entire list. Note that you must @{link #sort sort} the list before doing a search.
    
    Specified by:
    
    binarySearch in interface TCharList
    
    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
```
public int binarySearch(char value,
                        int fromIndex,
                        int toIndex)
```
    Description copied from interface: TCharList
    
    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.
    
    Specified by:
    
    binarySearch in interface TCharList
    
    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
```
public int indexOf(int offset,
                   char value)
```
    Description copied from interface: TCharList
    
    Searches the list front to back for the index of value, starting at offset.
    
    Specified by:
    
    indexOf in interface TCharList
    
    Parameters:
    
    offset - the offset at which to start the linear search (inclusive)
    
    value - an char 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
```
public int lastIndexOf(int offset,
                       char value)
```
    Description copied from interface: TCharList
    
    Searches the list back to front for the last index of value, starting at offset.
    
    Specified by:
    
    lastIndexOf in interface TCharList
    
    Parameters:
    
    offset - the offset at which to start the linear search (exclusive)
    
    value - an char 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
  - grep
```
public TCharList grep(TCharProcedure condition)
```
    Description copied from interface: TCharList
    
    Searches the list for values satisfying condition in the manner of the *nix grep utility.
    
    Specified by:
    
    grep in interface TCharList
    
    Parameters:
    
    condition - a condition to apply to each element in the list
    
    Returns:
    
    a list of values which match the condition.
  - inverseGrep
```
public TCharList inverseGrep(TCharProcedure condition)
```
    Description copied from interface: TCharList
    
    Searches the list for values which do not satisfy condition. This is akin to *nix grep -v.
    
    Specified by:
    
    inverseGrep in interface TCharList
    
    Parameters:
    
    condition - a condition to apply to each element in the list
    
    Returns:
    
    a list of values which do not match the condition.
  - max
```
public char max()
```
    Description copied from interface: TCharList
    
    Finds the maximum value in the list.
    
    Specified by:
    
    max in interface TCharList
    
    Returns:
    
    the largest value in the list.
  - min
```
public char min()
```
    Description copied from interface: TCharList
    
    Finds the minimum value in the list.
    
    Specified by:
    
    min in interface TCharList
    
    Returns:
    
    the smallest value in the list.
  - sum
```
public char sum()
```
    Description copied from interface: TCharList
    
    Calculates the sum of all the values in the list.
    
    Specified by:
    
    sum in interface TCharList
    
    Returns:
    
    the sum of the values in the list (zero if the list is empty).
  - subList
```
public TCharList subList(int fromIndex,
                         int toIndex)
```
    Description copied from interface: TCharList
    
    Returns a sublist of this list.
    
    Specified by:
    
    subList in interface TCharList
    
    Parameters:
    
    fromIndex - low endpoint (inclusive) of the subList.
    
    toIndex - high endpoint (exclusive) of the subList.
    
    Returns:
    
    sublist of this list from begin, inclusive to end, exclusive.
  - add
```
public void add(char[] vals)
```
    Description copied from interface: TCharList
    
    Adds the values in the array vals to the end of the list, in order.
    
    Specified by:
    
    add in interface TCharList
    
    Parameters:
    
    vals - an char[] value
  - add
```
public void add(char[] vals,
                int offset,
                int length)
```
    Description copied from interface: TCharList
    
    Adds a subset of the values in the array vals to the end of the list, in order.
    
    Specified by:
    
    add in interface TCharList
    
    Parameters:
    
    vals - an char[] value
    
    offset - the offset at which to start copying
    
    length - the number of values to copy.
  - removeAt
```
public char removeAt(int offset)
```
    Description copied from interface: TCharList
    
    Removes value at a given offset from the list.
    
    Specified by:
    
    removeAt in interface TCharList
    
    Parameters:
    
    offset - an int value that represents the offset to the element to be removed
    
    Returns:
    
    an char that is the value removed.
  - remove
```
public void remove(int offset,
                   int length)
```
    Description copied from interface: TCharList
    
    Removes length values from the list, starting at offset
    
    Specified by:
    
    remove in interface TCharList
    
    Parameters:
    
    offset - an int value
    
    length - an int value
  - insert
```
public void insert(int offset,
                   char value)
```
    Description copied from interface: TCharList
    
    Inserts value into the list at offset. All values including and to the right of offset are shifted to the right.
    
    Specified by:
    
    insert in interface TCharList
    
    Parameters:
    
    offset - an int value
    
    value - an char value
  - insert
```
public void insert(int offset,
                   char[] values)
```
    Description copied from interface: TCharList
    
    Inserts the array of values into the list at offset. All values including and to the right of offset are shifted to the right.
    
    Specified by:
    
    insert in interface TCharList
    
    Parameters:
    
    offset - an int value
    
    values - an char[] value
  - insert
```
public void insert(int offset,
                   char[] values,
                   int valOffset,
                   int len)
```
    Description copied from interface: TCharList
    
    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.
    
    Specified by:
    
    insert in interface TCharList
    
    Parameters:
    
    offset - an int value
    
    values - an char[] value
    
    valOffset - the offset in the values array at which to start copying.
    
    len - the number of values to copy from the values array
  - set
```
public char set(int offset,
                char val)
```
    Description copied from interface: TCharList
    
    Sets the value at the specified offset.
    
    Specified by:
    
    set in interface TCharList
    
    Parameters:
    
    offset - an int value
    
    val - an char value
    
    Returns:
    
    The value previously at the given index.
  - set
```
public void set(int offset,
                char[] values)
```
    Description copied from interface: TCharList
    
    Replace the values in the list starting at offset with the contents of the values array.
    
    Specified by:
    
    set in interface TCharList
    
    Parameters:
    
    offset - the first offset to replace
    
    values - the source of the new values
  - set
```
public void set(int offset,
                char[] values,
                int valOffset,
                int length)
```
    Description copied from interface: TCharList
    
    Replace the values in the list starting at offset with length values from the values array, starting at valOffset.
    
    Specified by:
    
    set in interface TCharList
    
    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
```
public char replace(int offset,
                    char val)
```
    Description copied from interface: TCharList
    
    Sets the value at the specified offset and returns the previously stored value.
    
    Specified by:
    
    replace in interface TCharList
    
    Parameters:
    
    offset - an int value
    
    val - an char value
    
    Returns:
    
    the value previously stored at offset.
  - transformValues
```
public void transformValues(TCharFunction function)
```
    Description copied from interface: TCharList
    
    Transform each value in the list using the specified function.
    
    Specified by:
    
    transformValues in interface TCharList
    
    Parameters:
    
    function - a TCharFunction value
  - reverse
```
public void reverse()
```
    Description copied from interface: TCharList
    
    Reverse the order of the elements in the list.
  - reverse
```
public void reverse(int from,
                    int to)
```
    Description copied from interface: TCharList
    
    Reverse the order of the elements in the range of the list.
    
    Specified by:
    
    reverse in interface TCharList
    
    Parameters:
    
    from - the inclusive index at which to start reversing
    
    to - the exclusive index at which to stop reversing
  - shuffle
```
public void shuffle(Random rand)
```
    Description copied from interface: TCharList
    
    Shuffle the elements of the list using the specified random number generator.
    
    Specified by:
    
    shuffle in interface TCharList
    
    Parameters:
    
    rand - a Random value
  - sort
```
public void sort()
```
    Description copied from interface: TCharList
    
    Sort the values in the list (ascending) using the Sun quicksort implementation.
    
    Specified by:
    
    sort in interface TCharList
    
    See Also:
    
    Arrays.sort(int[])
  - sort
```
public void sort(int fromIndex,
                 int toIndex)
```
    Description copied from interface: TCharList
    
    Sort a slice of the list (ascending) using the Sun quicksort implementation.
    
    Specified by:
    
    sort in interface TCharList
    
    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
```
public void fill(char val)
```
    Description copied from interface: TCharList
    
    Fills every slot in the list with the specified value.
    
    Specified by:
    
    fill in interface TCharList
    
    Parameters:
    
    val - the value to use when filling
  - fill
```
public void fill(int fromIndex,
                 int toIndex,
                 char val)
```
    Description copied from interface: TCharList
    
    Fills a range in the list with the specified value.
    
    Specified by:
    
    fill in interface TCharList
    
    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

Class TUnmodifiableCharList

Constructor Summary

Constructors

Method Summary

Methods inherited from class gnu.trove.impl.unmodifiable.TUnmodifiableCharCollection

Methods inherited from class java.lang.Object

Methods inherited from interface gnu.trove.list.TCharList

Methods inherited from interface gnu.trove.TCharCollection

Constructor Detail

TUnmodifiableCharList

Method Detail

equals

hashCode

get

indexOf

lastIndexOf

toArray

toArray

toArray

forEachDescending

binarySearch

binarySearch

indexOf

lastIndexOf

grep

inverseGrep

max

min

sum

subList

add

add

removeAt

remove

insert

insert

insert

set

set

set

replace

transformValues

reverse

reverse

shuffle

sort

sort

fill

fill