XCharIndexedList (Talon 3.14.19 API)

java.lang.Object
- com.neeve.lang.XCharCollectionBase
- - com.neeve.lang.XCharIndexedList

All Implemented Interfaces:

XCharCollection, XCharList, RandomAccess
```
public class XCharIndexedList
extends XCharCollectionBase
implements XCharList, RandomAccess
```
This class represents a random access collection with real-time behavior (smooth capacity increase) for a primitivive list of chars

This class has the following advantages over the widely used java.util.ArrayList:
- No large array allocation (for large collections multi-dimensional arrays are employed). The garbage collector is not stressed with large chunk of memory to allocate (likely to trigger a full garbage collection due to memory fragmentation).
- No autoboxing garbage associate with converting between primitive char and Character.
- Support concurrent access/iteration/modification without synchronization if marked shared.
Iterations over the XCharIndexedList values are faster when performed using the get(int) method rather than using collection records or iterators:[code] for (int i = 0, n = list.size(); i < n; i++) { list.get(i); }[/code]

This class was based on collections code from http://javolution.org, but modified for use outside of realtime jvms.

Constructor Summary

Constructors
Constructor and Description
`XCharIndexedList()` Creates a list of small initial capacity.
`XCharIndexedList(int capacity)` Creates a list of specified initial capacity; unless the list size reaches the specified capacity, operations on this list will not allocate memory (no lazy object creation).
`XCharIndexedList(XCharCollection values)` Creates a list containing the specified values, in the order they are returned by the collection's iterator.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(char value)` Appends the specified value to the end of this list.
`void`	`add(int index, char value)` Inserts the specified value at the specified position in this list.
`boolean`	`addAll(int index, XCharCollection values)` Inserts all of the values in the specified collection into this list at the specified position.
`void`	`addLast(char value)` Appends the specified value to the end of this list (fast).
`void`	`clear()` Removes all of the values from this collection (optional operation).
`boolean`	`contains(char value)` Indicates if this collection contains the specified value.
`void`	`delete(XCollection.Record record)` Deletes the specified record from this collection.
`char`	`get(int index)` Returns the element at the specified index.
`char`	`getFirst()` Returns the first value of this list.
`char`	`getLast()` Returns the last value of this list.
`XCollection.Record`	`head()` Returns the head record of this collection; it is the record such as `head().getNext()` holds the first collection value.
`int`	`indexOf(char value)` Returns the index in this list of the first occurrence of the specified value, or -1 if this list does not contain this value.
`XCharIterator`	`iterator()` Returns an iterator over the elements in this list
`int`	`lastIndexOf(char value)` Returns the index in this list of the last occurrence of the specified value, or -1 if this list does not contain this value.
`XCharListIterator`	`listIterator()` Returns a list iterator over the elements in this list
`XCharListIterator`	`listIterator(int index)` Returns a list iterator from the specified position
`static XCharIndexedList`	`newInstance()` Returns a new, preallocated or recycled `XCharIndexedList` instance
`char`	`remove(int index)` Removes the value at the specified position from this list.
`char`	`removeLast()` Removes and returns the last value of this list (fast).
`void`	`removeRange(int fromIndex, int toIndex)` Removes the values between `[fromIndex..toIndex[ from this list.`
`void`	`reset()`
`char`	`set(int index, char value)` Replaces the value at the specified position in this list with the specified value.
`void`	`setSize(int size)` Sets the size of this list.
`int`	`size()` Returns the number of values in this collection.
`void`	`sort(boolean ascending)`
`XCharList`	`subList(int fromIndex, int toIndex)` Returns a view of the portion of this list between the specified If the specified indexes are equal, the returned list is empty.
`XCollection.Record`	`tail()` Returns the tail record of this collection; it is the record such as `tail().getPrevious()` holds the last collection value.
`void`	`trimToSize()` Reduces the capacity of this list to the current size (minimize storage space).
`XCharList`	`unmodifiable()` Returns the unmodifiable view associated to this collection.
`char`	`valueOf(XCollection.Record record)` Returns the collection value for the specified record.

Methods inherited from class com.neeve.lang.XCharCollectionBase
addAll, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, reusableIterator, shared, supportsIteratorModifications, toArray, toArray, toString

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

Methods inherited from interface com.neeve.lang.XCharList
addAll, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from interface com.neeve.lang.XCharCollection
reusableIterator, shared, supportsIteratorModifications

- Constructor Detail
  - XCharIndexedList
```
public XCharIndexedList()
```
    Creates a list of small initial capacity.
  - XCharIndexedList
```
public XCharIndexedList(int capacity)
```
    Creates a list of specified initial capacity; unless the list size reaches the specified capacity, operations on this list will not allocate memory (no lazy object creation).
    
    Parameters:
    capacity - the initial capacity.
  - XCharIndexedList
```
public XCharIndexedList(XCharCollection values)
```
    Creates a list containing the specified values, in the order they are returned by the collection's iterator.
    
    Parameters:
    values - the values to be placed into this list.
- Method Detail
  - newInstance
```
public static XCharIndexedList newInstance()
```
    Returns a new, preallocated or recycled XCharIndexedList instance
    
    Returns:
    a new, preallocated or recycled XCharIndexedList instance.
  - setSize
```
public void setSize(int size)
```
    Sets the size of this list. If the specified size is greater than the current size then null elements are added; otherwise the last elements are removed until the desired size is reached.
    
    Parameters:
    size - the new size.
  - get
```
public final char get(int index)
```
    Returns the element at the specified index.
    
    Specified by:
    
    get in interface XCharList
    
    Parameters:
    index - index of value to return.
    
    Returns:
    the value at the specified position in this list.
    
    Throws:
    
    IndexOutOfBoundsException - if (index < 0) || (index >= size())
  - set
```
public final char set(int index,
       char value)
```
    Replaces the value at the specified position in this list with the specified value.
    
    Specified by:
    
    set in interface XCharList
    
    Parameters:
    index - index of value to replace.
    value - value to be stored at the specified position.
    
    Returns:
    previous value.
    
    Throws:
    
    IndexOutOfBoundsException - if (index < 0) || (index >= size())
  - add
```
public final boolean add(char value)
```
    Appends the specified value to the end of this list.
    
    Specified by:
    
    add in interface XCharCollection
    
    Specified by:
    
    add in interface XCharList
    
    Overrides:
    
    add in class XCharCollectionBase
    
    Parameters:
    value - the value to be appended to this list.
    
    Returns:
    true (as per the general contract of the Collection.add method).
  - getFirst
```
public final char getFirst()
```
    Returns the first value of this list.
    
    Returns:
    this list first value.
    
    Throws:
    
    NoSuchElementException - if this list is empty.
  - getLast
```
public final char getLast()
```
    Returns the last value of this list.
    
    Returns:
    this list last value.
    
    Throws:
    
    NoSuchElementException - if this list is empty.
  - addLast
```
public final void addLast(char value)
```
    Appends the specified value to the end of this list (fast).
    
    Parameters:
    value - the value to be added.
  - removeLast
```
public final char removeLast()
```
    Removes and returns the last value of this list (fast).
    
    Returns:
    this list's last value before this call.
    
    Throws:
    
    NoSuchElementException - if this list is empty.
  - clear
```
public final void clear()
```
    Description copied from class: XCharCollectionBase
    
    Removes all of the values from this collection (optional operation).
    
    Specified by:
    
    clear in interface XCharCollection
    
    Specified by:
    
    clear in interface XCharList
    
    Overrides:
    
    clear in class XCharCollectionBase
  - reset
```
public void reset()
```
  - addAll
```
public final boolean addAll(int index,
             XCharCollection values)
```
    Inserts all of the values in the specified collection into this list at the specified position. Shifts the value currently at that position (if any) and any subsequent values to the right (increases their indices).
    Note: If this method is used concurrent access must be synchronized (the list is no more thread-safe).
    
    Specified by:
    
    addAll in interface XCharList
    
    Parameters:
    index - the index at which to insert first value from the specified collection.
    values - the values to be inserted into this list.
    
    Returns:
    true if this list changed as a result of the call; false otherwise.
    
    Throws:
    
    IndexOutOfBoundsException - if (index < 0) || (index > size())
  - add
```
public final void add(int index,
       char 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).
    Note: If this method is used concurrent access must be synchronized (the list is no more thread-safe).
    
    Specified by:
    
    add in interface XCharList
    
    Parameters:
    index - the index at which the specified value is to be inserted.
    value - the value to be inserted.
    
    Throws:
    
    IndexOutOfBoundsException - if (index < 0) || (index > size())
  - remove
```
public final char remove(int index)
```
    Removes the value at the specified position from this list. Shifts any subsequent values to the left (subtracts one from their indices). Returns the value that was removed from the list.
    Note: If this method is used concurrent access must be synchronized (the list is no more thread-safe).
    
    Specified by:
    
    remove in interface XCharList
    
    Parameters:
    index - the index of the value to removed.
    
    Returns:
    the value previously at the specified position.
    
    Throws:
    
    IndexOutOfBoundsException - if (index < 0) || (index >= size())
  - removeRange
```
public final void removeRange(int fromIndex,
               int toIndex)
```
    Removes the values between [fromIndex..toIndex[ from this list. Note: If this method is used concurrent access must be synchronized (the list is no more thread-safe).
    Parameters: fromIndex - the beginning index, inclusive. toIndex - the ending index, exclusive. Throws: IndexOutOfBoundsException - if (fromIndex < 0) || (toIndex < 0) || (fromIndex > toIndex) || (toIndex > this.size())
  indexOf public final int indexOf(char value) Returns the index in this list of the first occurrence of the specified value, or -1 if this list does not contain this value. Specified by: indexOf in interface XCharList Parameters: value - the value to search for. Returns: the index in this list of the first occurrence of the specified value, or -1 if this list does not contain this value. lastIndexOf public final int lastIndexOf(char value) Returns the index in this list of the last occurrence of the specified value, or -1 if this list does not contain this value. Specified by: lastIndexOf in interface XCharList Parameters: value - the value to search for. Returns: the index in this list of the last occurrence of the specified value, or -1 if this list does not contain this value. iterator public XCharIterator iterator() Returns an iterator over the elements in this list Specified by: iterator in interface XCharCollection Specified by: iterator in interface XCharList Overrides: iterator in class XCharCollectionBase Returns: an iterator over this list values. listIterator public XCharListIterator listIterator() Returns a list iterator over the elements in this list Specified by: listIterator in interface XCharList Returns: an iterator over this list values. listIterator public XCharListIterator listIterator(int index) Returns a list iterator from the specified position Specified by: listIterator in interface XCharList Parameters: index - the index of first value to be returned from the list iterator (by a call to the next method). Returns: a list iterator of the values in this list starting at the specified position in this list. Throws: IndexOutOfBoundsException - if the index is out of range [code](index < 0 || index > size())[/code] subList public final XCharList subList(int fromIndex, int toIndex) Returns a view of the portion of this list between the specified If the specified indexes are equal, the returned list is empty. The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. 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 values from a list: [code] list.subList(from, to).clear();[/code] Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList. The semantics of the list returned by this method become undefined 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, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results). Specified by: subList in interface XCharList 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 - if [code](fromIndex < 0 || toIndex > size || fromIndex > toIndex)[/code] trimToSize public final void trimToSize() Reduces the capacity of this list to the current size (minimize storage space). sort public void sort(boolean ascending) size public final int size() Description copied from class: XCharCollectionBase Returns the number of values in this collection. Specified by: size in interface XCharCollection Specified by: size in interface XCharList Specified by: size in class XCharCollectionBase Returns: the number of values. head public final XCollection.Record head() Description copied from class: XCharCollectionBase Returns the head record of this collection; it is the record such as head().getNext() holds the first collection value. Specified by: head in interface XCharCollection Specified by: head in class XCharCollectionBase Returns: the head record. tail public final XCollection.Record tail() Description copied from class: XCharCollectionBase Returns the tail record of this collection; it is the record such as tail().getPrevious() holds the last collection value. Specified by: tail in interface XCharCollection Specified by: tail in class XCharCollectionBase Returns: the tail record. valueOf public final char valueOf(XCollection.Record record) Description copied from class: XCharCollectionBase Returns the collection value for the specified record. Specified by: valueOf in interface XCharCollection Specified by: valueOf in class XCharCollectionBase Parameters: record - the record whose current value is returned. Returns: the current value. delete public final void delete(XCollection.Record record) Description copied from class: XCharCollectionBase Deletes the specified record from this collection. Implementation must ensure that removing a record from the collection does not affect in any way the records preceding the record being removed (it might affect the next records though, e.g. in a list collection, the indices of the subsequent records will change). Specified by: delete in interface XCharCollection Specified by: delete in class XCharCollectionBase Parameters: record - the record to be removed. unmodifiable public XCharList unmodifiable() Description copied from class: XCharCollectionBase Returns the unmodifiable view associated to this collection. Attempts to modify the returned collection result in an UnsupportedOperationException being thrown. Specified by: unmodifiable in interface XCharCollection Overrides: unmodifiable in class XCharCollectionBase Returns: the unmodifiable view over this collection. contains public final boolean contains(char value) Description copied from class: XCharCollectionBase Indicates if this collection contains the specified value. Specified by: contains in interface XCharCollection Specified by: contains in interface XCharList Overrides: contains in class XCharCollectionBase Parameters: value - the value whose presence in this collection is to be tested. Returns: true if this collection contains the specified value;false otherwise.

Class XCharIndexedList

Constructor Summary

Method Summary

Methods inherited from class com.neeve.lang.XCharCollectionBase

Methods inherited from class java.lang.Object

Methods inherited from interface com.neeve.lang.XCharList

Methods inherited from interface com.neeve.lang.XCharCollection

Constructor Detail

XCharIndexedList

XCharIndexedList

XCharIndexedList

Method Detail

newInstance

setSize

get

set

add

getFirst

getLast

addLast

removeLast

clear

reset

addAll

add

remove

removeRange

indexOf

lastIndexOf

iterator

listIterator

listIterator

subList

trimToSize

sort

size

head

tail

valueOf

delete

unmodifiable

contains