CharArrayList (RegExodus 0.1.3)

java.lang.Object
- regexodus.ds.CharArrayList

All Implemented Interfaces:

Serializable, Cloneable, Comparable<List<? extends Character>>, Iterable<Character>, Collection<Character>, List<Character>, RandomAccess
```
public class CharArrayList
extends Object
implements RandomAccess, Cloneable, Serializable, List<Character>, Comparable<List<? extends Character>>
```
A type-specific array-based list; provides some additional methods that use polymorphism to avoid (un)boxing.

This class implements a lightweight, fast, open, optimized, reuse-oriented version of array-based lists. Instances of this class represent a list with an array that is enlarged as needed when new entries are created (by doubling its current length), but is never made smaller (even on a clear()). A family of trimming methods lets you control the size of the backing array; this is particularly useful if you reuse instances of this class. Range checks are equivalent to those of java.util's classes, but they are delayed as much as possible. The backing array is exposed by the elements() method.

This class implements the bulk methods removeElements(), addElements() and getElements() using high-performance system calls (e.g., System.arraycopy() instead of expensive loops.

See Also:

ArrayList, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class CharArrayList.CharListIterator

Nested Classes
Modifier and Type	Class and Description
`class`	`CharArrayList.CharListIterator`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CharArrayList(char[] a, boolean dummy)` Creates a new array list using a given array.
	`CharArrayList(CharArrayList l)` Creates a new array list and fills it with a given type-specific list.
	`CharArrayList(int capacity)` Creates a new array list with given capacity.
	`CharArrayList(Iterator<? extends Character> i)` Creates a new array list and fills it with the elements returned by an iterator..
	`CharArrayList(String s)` Creates a new array list and fills it with the elements of a given String.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(Character o)` Delegates to the corresponding type-specific method.
`boolean`	`add(int k)`
`void`	`add(int index, Character element)` Inserts the specified element at the specified position in this list (optional operation).
`boolean`	`addAll(Collection<? extends Character> c)` Adds all elements of the given collection to this collection.
`boolean`	`addAll(int index, CharArrayList l)`
`boolean`	`addAll(int index, Collection<? extends Character> c)`
`void`	`addElements(int index, char[] a, int offset, int length)` Adds elements to this type-specific list using optimized system calls.
`void`	`clear()`
`CharArrayList`	`clone()`
`int`	`compareTo(CharArrayList l)` Compares this array list to another array list.
`int`	`compareTo(List<? extends Character> l)` Compares this list to another object.
`boolean`	`contains(Object o)` Delegates to the corresponding type-specific method.
`boolean`	`containsAll(Collection<?> c)` Checks whether this collection contains all elements from the given collection.
`char[]`	`elements()` Returns the backing array of this list.
`protected void`	`ensureRestrictedIndex(int index)` Ensures that the given index is non-negative and smaller than the list size.
`boolean`	`equals(CharArrayList l)` Compares this type-specific array list to another one.
`Character`	`get(int index)` Deprecated. Please use the corresponding type-specific method instead.
`char`	`getChar(int index)`
`int`	`getCodePoint(int index)`
`int`	`hashCode()` Returns the hash code for this list, which is identical to `List.hashCode()`.
`int`	`indexOf(Object o)` Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
`boolean`	`isEmpty()`
`CharArrayList.CharListIterator`	`iterator()`
`int`	`lastIndexOf(char k)`
`int`	`lastIndexOf(Object o)` Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
`CharArrayList.CharListIterator`	`listIterator()`
`CharArrayList.CharListIterator`	`listIterator(int index)`
`Character`	`remove(int index)` Removes the element at the specified position in this list (optional operation).
`boolean`	`remove(Object ok)` Delegates to the type-specific `rem()` method.
`boolean`	`removeAll(Collection<?> c)` Removes from this list all of its elements that are contained in the specified collection (optional operation).
`void`	`removeElements(int from, int to)` Removes elements of this type-specific list using optimized system calls.
`boolean`	`retainAll(Collection<?> c)` Retains only the elements in this list that are contained in the specified collection (optional operation).
`Character`	`set(int index, Character ok)` Deprecated. Please use the corresponding type-specific method instead.
`int`	`size()`
`void`	`size(int size)`
`List<Character>`	`subList(int fromIndex, int toIndex)` Returns a view of the portion of this list between the specified `fromIndex`, inclusive, and `toIndex`, exclusive.
`Object[]`	`toArray()`
`char[]`	`toArray(char[] a)`
`Character[]`	`toArray(Character[] a)`
`<T> T[]`	`toArray(T[] a)` Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.
`char[]`	`toCharArray()`
`String`	`toString()`
`void`	`trim()` Trims this array list so that the capacity is equal to the size.
`static int`	`unwrap(CharArrayList.CharListIterator i, char[] array)` Unwraps an iterator into an array starting at a given offset for a given number of elements.
`static CharArrayList`	`wrap(char[] a)` Wraps a given array into an array list.

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

Methods inherited from interface java.util.List
equals, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - CharArrayList
```
protected CharArrayList(char[] a,
                        boolean dummy)
```
    Creates a new array list using a given array.
    
    This constructor is only meant to be used by the wrapping methods.
    
    Parameters:
    
    a - the array that will be used to back this array list.
  - CharArrayList
```
public CharArrayList(int capacity)
```
    Creates a new array list with given capacity.
    
    Parameters:
    
    capacity - the initial capacity of the array list (may be 0).
  - CharArrayList
```
public CharArrayList(CharArrayList l)
```
    Creates a new array list and fills it with a given type-specific list.
    
    Parameters:
    
    l - a type-specific list that will be used to fill the array list.
  - CharArrayList
```
public CharArrayList(String s)
```
    Creates a new array list and fills it with the elements of a given String.
    
    Parameters:
    
    s - a String whose char elements will be used to fill the array list.
  - CharArrayList
```
public CharArrayList(Iterator<? extends Character> i)
```
    Creates a new array list and fills it with the elements returned by an iterator..
    
    Parameters:
    
    i - an iterator whose returned elements will fill the array list.
- Method Detail
  - elements
```
public char[] elements()
```
    Returns the backing array of this list.
    
    Returns:
    
    the backing array.
  - wrap
```
public static CharArrayList wrap(char[] a)
```
    Wraps a given array into an array list.
    
    Note it is guaranteed that the type of the array returned by elements() will be the same (see the comments in the class documentation).
    
    Parameters:
    
    a - an array to wrap.
    
    Returns:
    
    a new array list wrapping the given array.
  - add
```
public boolean add(int k)
```
  - getChar
```
public char getChar(int index)
```
  - getCodePoint
```
public int getCodePoint(int index)
```
  - lastIndexOf
```
public int lastIndexOf(char k)
```
  - set
```
@Deprecated
public Character set(int index,
                                  Character ok)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Delegates to the corresponding type-specific method.
    
    Specified by:
    
    set in interface List<Character>
  - add
```
public void add(int index,
                Character element)
```
    Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
    
    Specified by:
    
    add in interface List<Character>
    
    Parameters:
    
    index - index at which the specified element is to be inserted
    
    element - element to be inserted
    
    Throws:
    
    UnsupportedOperationException - if the add operation is not supported by this list
    
    ClassCastException - if the class of the specified element prevents it from being added to this list
    
    NullPointerException - if the specified element is null and this list does not permit null elements
    
    IllegalArgumentException - if some property of the specified element prevents it from being added to this list
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())
  - remove
```
public Character remove(int index)
```
    Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.
    
    Specified by:
    
    remove in interface List<Character>
    
    Parameters:
    
    index - the index of the element to be removed
    
    Returns:
    
    the element previously at the specified position
    
    Throws:
    
    UnsupportedOperationException - if the remove operation is not supported by this list
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
  - indexOf
```
public int indexOf(Object o)
```
    Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
    
    Specified by:
    
    indexOf in interface List<Character>
    
    Parameters:
    
    o - element to search for
    
    Returns:
    
    the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element
    
    Throws:
    
    ClassCastException - if the type of the specified element is incompatible with this list (optional)
    
    NullPointerException - if the specified element is null and this list does not permit null elements (optional)
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
    
    Specified by:
    
    lastIndexOf in interface List<Character>
    
    Parameters:
    
    o - element to search for
    
    Returns:
    
    the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element
    
    Throws:
    
    ClassCastException - if the type of the specified element is incompatible with this list (optional)
    
    NullPointerException - if the specified element is null and this list does not permit null elements (optional)
  - addAll
```
public boolean addAll(int index,
                      Collection<? extends Character> c)
```
    Specified by:
    
    addAll in interface List<Character>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Removes from this list all of its elements that are contained in the specified collection (optional operation).
    
    Specified by:
    
    removeAll in interface Collection<Character>
    
    Specified by:
    
    removeAll in interface List<Character>
    
    Parameters:
    
    c - collection containing elements to be removed from this list
    
    Returns:
    
    true if this list changed as a result of the call
    
    Throws:
    
    UnsupportedOperationException - if the removeAll operation is not supported by this list
    
    ClassCastException - if the class of an element of this list is incompatible with the specified collection (optional)
    
    NullPointerException - if this list contains a null element and the specified collection does not permit null elements (optional), or if the specified collection is null
    
    See Also:
    
    remove(Object), contains(Object)
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all of its elements that are not contained in the specified collection.
    
    Specified by:
    
    retainAll in interface Collection<Character>
    
    Specified by:
    
    retainAll in interface List<Character>
    
    Parameters:
    
    c - collection containing elements to be retained in this list
    
    Returns:
    
    true if this list changed as a result of the call
    
    Throws:
    
    UnsupportedOperationException - if the retainAll operation is not supported by this list
    
    ClassCastException - if the class of an element of this list is incompatible with the specified collection (optional)
    
    NullPointerException - if this list contains a null element and the specified collection does not permit null elements (optional), or if the specified collection is null
    
    See Also:
    
    remove(Object), contains(Object)
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<Character>
    
    Specified by:
    
    clear in interface List<Character>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<Character>
    
    Specified by:
    
    size in interface List<Character>
  - size
```
public void size(int size)
```
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<Character>
    
    Specified by:
    
    isEmpty in interface List<Character>
  - trim
```
public void trim()
```
    Trims this array list so that the capacity is equal to the size.
    
    See Also:
    
    ArrayList.trimToSize()
  - removeElements
```
public void removeElements(int from,
                           int to)
```
    Removes elements of this type-specific list using optimized system calls.
    
    Parameters:
    
    from - the start index (inclusive).
    
    to - the end index (exclusive).
  - addElements
```
public void addElements(int index,
                        char[] a,
                        int offset,
                        int length)
```
    Adds elements to this type-specific list using optimized system calls.
    
    Parameters:
    
    index - the index at which to add elements.
    
    a - the array containing the elements.
    
    offset - the offset of the first element to add.
    
    length - the number of elements to add.
  - addAll
```
public boolean addAll(int index,
                      CharArrayList l)
```
  - iterator
```
public CharArrayList.CharListIterator iterator()
```
    Specified by:
    
    iterator in interface Iterable<Character>
    
    Specified by:
    
    iterator in interface Collection<Character>
    
    Specified by:
    
    iterator in interface List<Character>
  - listIterator
```
public CharArrayList.CharListIterator listIterator()
```
    Specified by:
    
    listIterator in interface List<Character>
  - listIterator
```
public CharArrayList.CharListIterator listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<Character>
  - subList
```
public List<Character> 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 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 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 List<Character>
    
    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 an illegal endpoint index value (fromIndex < 0 || toIndex > size || fromIndex > toIndex)
  - clone
```
public CharArrayList clone()
```
    Overrides:
    
    clone in class Object
  - equals
```
public boolean equals(CharArrayList l)
```
    Compares this type-specific array list to another one.
    
    This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
    
    Parameters:
    
    l - a type-specific array list.
    
    Returns:
    
    true if the argument contains the same elements of this type-specific array list.
  - compareTo
```
public int compareTo(CharArrayList l)
```
    Compares this array list to another array list.
    
    This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
    
    Parameters:
    
    l - an array list.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
  - compareTo
```
public int compareTo(List<? extends Character> l)
```
    Compares this list to another object. If the argument is a List, this method performs a lexicographical comparison; otherwise, it throws a ClassCastException.
    
    Specified by:
    
    compareTo in interface Comparable<List<? extends Character>>
    
    Parameters:
    
    l - a list.
    
    Returns:
    
    if the argument is a List, a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
    
    Throws:
    
    ClassCastException - if the argument is not a list.
  - hashCode
```
public int hashCode()
```
    Returns the hash code for this list, which is identical to List.hashCode().
    
    Specified by:
    
    hashCode in interface Collection<Character>
    
    Specified by:
    
    hashCode in interface List<Character>
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code for this list.
  - get
```
@Deprecated
public Character get(int index)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Delegates to the corresponding type-specific method.
    
    Specified by:
    
    get in interface List<Character>
  - ensureRestrictedIndex
```
protected void ensureRestrictedIndex(int index)
```
    Ensures that the given index is non-negative and smaller than the list size.
    
    Parameters:
    
    index - an index.
    
    Throws:
    
    IndexOutOfBoundsException - if the given index is negative or not smaller than the list size.
  - contains
```
public boolean contains(Object o)
```
    Delegates to the corresponding type-specific method.
    
    Specified by:
    
    contains in interface Collection<Character>
    
    Specified by:
    
    contains in interface List<Character>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<Character>
    
    Specified by:
    
    toArray in interface List<Character>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list.
    
    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 null. (This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.)
    
    Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.
    
    Suppose x is a list known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:
```
     String[] y = x.toArray(new String[0]);
 
```
    Note that toArray(new Object[0]) is identical in function to toArray().
    Specified by:
    
    toArray in interface Collection<Character>
    
    Specified by:
    
    toArray in interface List<Character>
    
    Parameters:
    
    a - the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
    
    Returns:
    
    an array containing the elements of this list
    
    Throws:
    
    ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this list
    
    NullPointerException - if the specified array is null
  - toArray
```
public Character[] toArray(Character[] a)
```
  - add
```
public boolean add(Character o)
```
    Delegates to the corresponding type-specific method.
    
    Specified by:
    
    add in interface Collection<Character>
    
    Specified by:
    
    add in interface List<Character>
  - remove
```
public boolean remove(Object ok)
```
    Delegates to the type-specific rem() method.
    
    Specified by:
    
    remove in interface Collection<Character>
    
    Specified by:
    
    remove in interface List<Character>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Checks whether this collection contains all elements from the given collection.
    
    Specified by:
    
    containsAll in interface Collection<Character>
    
    Specified by:
    
    containsAll in interface List<Character>
    
    Parameters:
    
    c - a collection.
    
    Returns:
    
    true if this collection contains all elements of the argument.
  - addAll
```
public boolean addAll(Collection<? extends Character> c)
```
    Adds all elements of the given collection to this collection.
    
    Specified by:
    
    addAll in interface Collection<Character>
    
    Specified by:
    
    addAll in interface List<Character>
    
    Parameters:
    
    c - a collection.
    
    Returns:
    
    true if this collection changed as a result of the call.
  - toArray
```
public char[] toArray(char[] a)
```
  - toCharArray
```
public char[] toCharArray()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - unwrap
```
public static int unwrap(CharArrayList.CharListIterator i,
                         char[] array)
```
    Unwraps an iterator into an array starting at a given offset for a given number of elements.
    
    This method iterates over the given type-specific iterator and stores the elements returned, up to a maximum of length, in the given array starting at offset. The number of actually unwrapped elements is returned (it may be less than max if the iterator emits less than max elements).
    
    Parameters:
    
    i - a type-specific iterator.
    
    array - an array to contain the output of the iterator.
    
    Returns:
    
    the number of elements unwrapped.

Class CharArrayList

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

CharArrayList

CharArrayList

CharArrayList

CharArrayList

CharArrayList

Method Detail

elements

wrap

add

getChar

getCodePoint

lastIndexOf

set

add

remove

indexOf

lastIndexOf

addAll

removeAll

retainAll

clear

size

size

isEmpty

trim

removeElements

addElements

addAll

iterator

listIterator

listIterator

subList

clone

equals

compareTo

compareTo

hashCode

get

ensureRestrictedIndex

contains

toArray

toArray

toArray

add

remove

containsAll

addAll

toArray

toCharArray

toString

unwrap