Class TCharArrayList
- All Implemented Interfaces:
TCharList
,TCharCollection
,Externalizable
,Serializable
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected char[]
the data of the listprotected int
the index after the last entry in the listprotected static final int
the default capacity for new listsprotected char
the char value that represents null -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreates a newTCharArrayList
instance with the default capacity.TCharArrayList
(char[] values) Creates a newTCharArrayList
instance whose capacity is the length of values array and whose initial contents are the specified values.protected
TCharArrayList
(char[] values, char no_entry_value, boolean wrap) TCharArrayList
(int capacity) Creates a newTCharArrayList
instance with the specified capacity.TCharArrayList
(int capacity, char no_entry_value) Creates a newTCharArrayList
instance with the specified capacity.TCharArrayList
(TCharCollection collection) Creates a newTCharArrayList
instance that contains a copy of the collection passed to us. -
Method Summary
Modifier and TypeMethodDescriptionboolean
add
(char val) Adds val to the end of the list, growing as needed.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.boolean
addAll
(char[] array) Adds all of the elements in the array to the collection.boolean
addAll
(TCharCollection collection) Adds all of the elements in the TCharCollection to the collection.boolean
addAll
(Collection<? extends Character> collection) Adds all of the elements in collection to the collection.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.void
clear()
Flushes the internal state of the list, resetting the capacity to the default.void
Sets the size of the list to 0, but does not change its capacity.boolean
contains
(char value) Searches the list for valueboolean
containsAll
(char[] array) Tests the collection to determine if all of the elements in array are present.boolean
containsAll
(TCharCollection collection) Tests the collection to determine if all of the elements in TCharCollection are present.boolean
containsAll
(Collection<?> collection) Tests the collection to determine if all of the elements in collection are present.void
ensureCapacity
(int capacity) Grow the internal array as needed to accommodate the specified number of elements.boolean
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
forEach
(TCharProcedure procedure) Applies the procedure to each value in the list in ascending (front to back) order.boolean
forEachDescending
(TCharProcedure procedure) Applies the procedure to each value in the list in descending (back to front) order.char
get
(int offset) Returns the value at the specified offset.char
Returns the value that is used to represent null.char
getQuick
(int offset) Returns the value at the specified offset without doing any bounds checking.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 value) 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.inverseGrep
(TCharProcedure condition) Searches the list for values which do not satisfy condition.boolean
isEmpty()
Tests whether this list contains any values.iterator()
Creates an iterator over the values of the collection.int
lastIndexOf
(char value) 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
boolean
remove
(char value) Removes value from the list.void
remove
(int offset, int length) Removes length values from the list, starting at offsetboolean
removeAll
(char[] array) Removes all of the elements in array from the collection.boolean
removeAll
(TCharCollection collection) Removes all of the elements in TCharCollection from the collection.boolean
removeAll
(Collection<?> collection) Removes all of the elements in collection from the collection.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.boolean
retainAll
(char[] array) Removes any values in the collection which are not contained in array.boolean
retainAll
(TCharCollection collection) Removes any values in the collection which are not contained in TCharCollection.boolean
retainAll
(Collection<?> collection) Removes any values in the collection which are not contained in collection.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
setQuick
(int offset, char val) Sets the value at the specified offset without doing any bounds checking.void
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.subList
(int begin, int end) Returns a sublist of this list.char
sum()
Calculates the sum of all the values in the list.char[]
toArray()
Copies the contents of the list into a native array.char[]
toArray
(char[] dest) Copies a slice of the list into a native array.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.toString()
void
transformValues
(TCharFunction function) Transform each value in the list using the specified function.void
Sheds any excess capacity above and beyond the current size of the list.static TCharArrayList
wrap
(char[] values) Returns a primitive List implementation that wraps around the given primitive array.static TCharArrayList
wrap
(char[] values, char no_entry_value) Returns a primitive List implementation that wraps around the given primitive array.void
-
Field Details
-
DEFAULT_CAPACITY
protected static final int DEFAULT_CAPACITYthe default capacity for new lists- See Also:
-
_data
protected char[] _datathe data of the list -
_pos
protected int _posthe index after the last entry in the list -
no_entry_value
protected char no_entry_valuethe char value that represents null
-
-
Constructor Details
-
TCharArrayList
public TCharArrayList()Creates a newTCharArrayList
instance with the default capacity. -
TCharArrayList
public TCharArrayList(int capacity) Creates a newTCharArrayList
instance with the specified capacity.- Parameters:
capacity
- anint
value
-
TCharArrayList
public TCharArrayList(int capacity, char no_entry_value) Creates a newTCharArrayList
instance with the specified capacity.- Parameters:
capacity
- anint
valueno_entry_value
- anchar
value that represents null.
-
TCharArrayList
Creates a newTCharArrayList
instance that contains a copy of the collection passed to us.- Parameters:
collection
- the collection to copy
-
TCharArrayList
public TCharArrayList(char[] values) Creates a newTCharArrayList
instance whose capacity is the length of values array and whose initial contents are the specified values.A defensive copy of the given values is held by the new instance.
- Parameters:
values
- anchar[]
value
-
TCharArrayList
protected TCharArrayList(char[] values, char no_entry_value, boolean wrap)
-
-
Method Details
-
wrap
Returns a primitive List implementation that wraps around the given primitive array.
NOTE: mutating operation are allowed as long as the List does not grow. In that case an IllegalStateException will be thrown
- Parameters:
values
-
-
wrap
Returns a primitive List implementation that wraps around the given primitive array.
NOTE: mutating operation are allowed as long as the List does not grow. In that case an IllegalStateException will be thrown
- Parameters:
values
-no_entry_value
-
-
getNoEntryValue
public char 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 interfaceTCharCollection
- Specified by:
getNoEntryValue
in interfaceTCharList
- Returns:
- the value that represents null
-
ensureCapacity
public void ensureCapacity(int capacity) Grow the internal array as needed to accommodate the specified number of elements. The size of the array bytes on each resize unless capacity requires more than twice the current capacity. -
size
public int size()Returns the number of values in the list.- Specified by:
size
in interfaceTCharCollection
- Specified by:
size
in interfaceTCharList
- Returns:
- the number of values in the list.
-
isEmpty
public boolean isEmpty()Tests whether this list contains any values.- Specified by:
isEmpty
in interfaceTCharCollection
- Specified by:
isEmpty
in interfaceTCharList
- Returns:
- true if the list is empty.
-
trimToSize
public void trimToSize()Sheds any excess capacity above and beyond the current size of the list. -
add
public boolean add(char val) Adds val to the end of the list, growing as needed.- Specified by:
add
in interfaceTCharCollection
- Specified by:
add
in interfaceTCharList
- Parameters:
val
- anchar
value- Returns:
- true if the list was modified by the add operation
-
add
public void add(char[] vals) Adds the values in the array vals to the end of the list, in order. -
add
public 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. -
insert
public void insert(int offset, char value) Inserts value into the list at offset. All values including and to the right of offset are shifted to the right. -
insert
public void insert(int offset, char[] 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. -
insert
public void insert(int offset, char[] 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. -
get
public char get(int offset) Returns the value at the specified offset. -
getQuick
public char getQuick(int offset) Returns the value at the specified offset without doing any bounds checking. -
set
public char set(int offset, char val) Sets the value at the specified offset. -
replace
public char replace(int offset, char val) Sets the value at the specified offset and returns the previously stored value. -
set
public void set(int offset, char[] values) Replace the values in the list starting at offset with the contents of the values array. -
set
public 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. -
setQuick
public void setQuick(int offset, char val) Sets the value at the specified offset without doing any bounds checking. -
clear
public void clear()Flushes the internal state of the list, resetting the capacity to the default.- Specified by:
clear
in interfaceTCharCollection
- Specified by:
clear
in interfaceTCharList
-
clearQuick
public void clearQuick()Sets the size of the list to 0, but does not change its capacity. This method can be used as an alternative to theclear()
method if you want reset the list state without incurring the cost of filling bank data in the list. Thus, it is possible for getQuick to return stale data if this method is used and the caller is careless about bounds checking. -
remove
public boolean remove(char value) Removes value from the list.- Specified by:
remove
in interfaceTCharCollection
- Specified by:
remove
in interfaceTCharList
- Parameters:
value
- anchar
value- Returns:
- true if the list was modified by the remove operation.
-
removeAt
public char removeAt(int offset) Removes value at a given offset from the list. -
remove
public void remove(int offset, int length) Removes length values from the list, starting at offset -
iterator
Creates an iterator over the values of the collection. The iterator supports element deletion.- Specified by:
iterator
in interfaceTCharCollection
- Returns:
- an
TCharIterator
value
-
containsAll
Tests the collection to determine if all of the elements in collection are present.- Specified by:
containsAll
in interfaceTCharCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if all elements were present in the collection.
-
containsAll
Tests the collection to determine if all of the elements in TCharCollection are present.- Specified by:
containsAll
in interfaceTCharCollection
- Parameters:
collection
- aTCharCollection
value- Returns:
- true if all elements were present in the collection.
-
containsAll
public boolean containsAll(char[] array) Tests the collection to determine if all of the elements in array are present.- Specified by:
containsAll
in interfaceTCharCollection
- Parameters:
array
- asarray
of char primitives.- Returns:
- true if all elements were present in the collection.
-
addAll
Adds all of the elements in collection to the collection.- Specified by:
addAll
in interfaceTCharCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if the collection was modified by the add all operation.
-
addAll
Adds all of the elements in the TCharCollection to the collection.- Specified by:
addAll
in interfaceTCharCollection
- Parameters:
collection
- aTCharCollection
value- Returns:
- true if the collection was modified by the add all operation.
-
addAll
public boolean addAll(char[] array) Adds all of the elements in the array to the collection.- Specified by:
addAll
in interfaceTCharCollection
- Parameters:
array
- aarray
of char primitives.- Returns:
- true if the collection was modified by the add all operation.
-
retainAll
Removes any values in the collection which are not contained in collection.- Specified by:
retainAll
in interfaceTCharCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if the collection was modified by the retain all operation
-
retainAll
Removes any values in the collection which are not contained in TCharCollection.- Specified by:
retainAll
in interfaceTCharCollection
- Parameters:
collection
- aTCharCollection
value- Returns:
- true if the collection was modified by the retain all operation
-
retainAll
public boolean retainAll(char[] array) Removes any values in the collection which are not contained in array.- Specified by:
retainAll
in interfaceTCharCollection
- Parameters:
array
- anarray
of char primitives.- Returns:
- true if the collection was modified by the retain all operation
-
removeAll
Removes all of the elements in collection from the collection.- Specified by:
removeAll
in interfaceTCharCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if the collection was modified by the remove all operation.
-
removeAll
Removes all of the elements in TCharCollection from the collection.- Specified by:
removeAll
in interfaceTCharCollection
- Parameters:
collection
- aTCharCollection
value- Returns:
- true if the collection was modified by the remove all operation.
-
removeAll
public boolean removeAll(char[] array) Removes all of the elements in array from the collection.- Specified by:
removeAll
in interfaceTCharCollection
- Parameters:
array
- anarray
of char primitives.- Returns:
- true if the collection was modified by the remove all operation.
-
transformValues
Transform each value in the list using the specified function.- Specified by:
transformValues
in interfaceTCharList
- Parameters:
function
- aTCharFunction
value
-
reverse
public void reverse()Reverse the order of the elements in the list. -
reverse
public void reverse(int from, int to) Reverse the order of the elements in the range of the list. -
shuffle
Shuffle the elements of the list using the specified random number generator. -
subList
Returns a sublist of this list. -
toArray
public char[] toArray()Copies the contents of the list into a native array.- Specified by:
toArray
in interfaceTCharCollection
- Specified by:
toArray
in interfaceTCharList
- Returns:
- an
char[]
value
-
toArray
public char[] toArray(int offset, int len) Copies a slice of the list into a native array. -
toArray
public char[] toArray(char[] 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
TCharList.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 interfaceTCharCollection
- Specified by:
toArray
in interfaceTCharList
- Parameters:
dest
- the array to copy into.- Returns:
- the array passed in.
-
toArray
public char[] toArray(char[] dest, int offset, int len) Copies a slice of the list into a native array. -
toArray
public char[] toArray(char[] dest, int source_pos, int dest_pos, int len) Copies a slice of the list into a native array. -
equals
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 interfaceTCharCollection
- Overrides:
equals
in classObject
- Parameters:
other
- object to be compared for equality with this collection- Returns:
- true if the specified object is equal to this collection
-
hashCode
public int hashCode()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 ofObject.hashCode()
.- Specified by:
hashCode
in interfaceTCharCollection
- Overrides:
hashCode
in classObject
- Returns:
- the hash code value for this collection
- See Also:
-
forEach
Applies the procedure to each value in the list in ascending (front to back) order.- Specified by:
forEach
in interfaceTCharCollection
- Specified by:
forEach
in interfaceTCharList
- Parameters:
procedure
- aTCharProcedure
value- Returns:
- true if the procedure did not terminate prematurely.
-
forEachDescending
Applies the procedure to each value in the list in descending (back to front) order.- Specified by:
forEachDescending
in interfaceTCharList
- Parameters:
procedure
- aTCharProcedure
value- Returns:
- true if the procedure did not terminate prematurely.
-
sort
public void sort()Sort the values in the list (ascending) using the Sun quicksort implementation. -
sort
public void sort(int fromIndex, int toIndex) Sort a slice of the list (ascending) using the Sun quicksort implementation. -
fill
public void fill(char val) Fills every slot in the list with the specified value. -
fill
public void fill(int fromIndex, int toIndex, char val) Fills a range in the list with the specified value. -
binarySearch
public int binarySearch(char value) 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 interfaceTCharList
- 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) 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 interfaceTCharList
- Parameters:
value
- the value to search forfromIndex
- 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(char value) Searches the list front to back for the index of value. -
indexOf
public int indexOf(int offset, char value) Searches the list front to back for the index of value, starting at offset. -
lastIndexOf
public int lastIndexOf(char value) Searches the list back to front for the last index of value.- Specified by:
lastIndexOf
in interfaceTCharList
- Parameters:
value
- anchar
value- Returns:
- the last offset of the value, or -1 if it is not in the list.
- See Also:
-
lastIndexOf
public int lastIndexOf(int offset, char value) Searches the list back to front for the last index of value, starting at offset.- Specified by:
lastIndexOf
in interfaceTCharList
- Parameters:
offset
- the offset at which to start the linear search (exclusive)value
- anchar
value- Returns:
- the last offset of the value, or -1 if it is not in the list.
- See Also:
-
contains
public boolean contains(char value) Searches the list for value- Specified by:
contains
in interfaceTCharCollection
- Specified by:
contains
in interfaceTCharList
- Parameters:
value
- anchar
value- Returns:
- true if value is in the list.
-
grep
Searches the list for values satisfying condition in the manner of the *nix grep utility. -
inverseGrep
Searches the list for values which do not satisfy condition. This is akin to *nixgrep -v
.- Specified by:
inverseGrep
in interfaceTCharList
- 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()Finds the maximum value in the list. -
min
public char min()Finds the minimum value in the list. -
sum
public char sum()Calculates the sum of all the values in the list. -
toString
-
writeExternal
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- Throws:
IOException
ClassNotFoundException
-