it.unimi.dsi.fastutil.chars
Class CharArrayList

java.lang.Object
  extended byit.unimi.dsi.fastutil.chars.AbstractCharCollection
      extended byit.unimi.dsi.fastutil.chars.AbstractCharList
          extended byit.unimi.dsi.fastutil.chars.CharArrayList
All Implemented Interfaces:
CharCollection, CharList, Cloneable, Collection, Comparable, List, RandomAccess, Serializable

public class CharArrayList
extends AbstractCharList
implements RandomAccess, Cloneable, Serializable

A type-specific ArrayList; provides some additional methods that use polymorphism to reduce type juggling.

This class implements a lightweight, fast, open, optimised, 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 dividing the current length by the golden ratio), 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() and getElements() using high-performance system calls (e.g., System.arraycopy() instead of expensive loops.

See Also:
ArrayList, Serialized Form

Field Summary
static int DEFAULT_INITIAL_CAPACITY
          The initial default capacity of an array list.
static long serialVersionUID
           
 
Constructor Summary
CharArrayList()
          Creates a new array list with DEFAULT_INITIAL_CAPACITY capacity.
CharArrayList(char[] a)
          Creates a new array list and fills it with the elements of a given array.
CharArrayList(char[] a, int offset, int length)
          Creates a new array list and fills it with the elements of a given array.
CharArrayList(CharCollection c)
          Creates a new array list and fills it with a given type-specific collection.
CharArrayList(CharIterator i)
          Creates a new array list and fills it with the elements returned by a type-specific iterator..
CharArrayList(CharList l)
          Creates a new array list and fills it with a given type-specific list.
CharArrayList(Collection c)
          Creates a new array list and fills it with a given collection.
CharArrayList(int capacity)
          Creates a new array list with given capacity.
CharArrayList(Iterator i)
          Creates a new array list and fills it with the elements returned by an iterator..
 
Method Summary
 boolean add(char k)
           
 void add(int index, char k)
           
 boolean addAll(CharList l)
          Delegates to a more generic method.
 boolean addAll(int index, CharCollection c)
          Delegates to a more generic method.
 boolean addAll(int index, CharList l)
          Delegates to a more generic method.
 CharListIterator charListIterator(int index)
          Returns a type-specific list iterator on the list starting at a given index.
 void clear()
           
 Object clone()
           
 int compareTo(CharArrayList l)
           
 char[] elements()
          Returns the backing array of this list.
 void ensureCapacity(int capacity)
          Ensures that this array list can contain the given number of entries without resizing.
 boolean equals(CharArrayList l)
           
 char getChar(int index)
           
 void getElements(int from, char[] a, int offset, int length)
          Copies element of this type-specific list into the given array using optimised system calls.
 int indexOf(char k)
           
 boolean isEmpty()
           
 int lastIndexOf(char k)
           
 boolean remove(char k)
           
 char removeChar(int index)
           
 void removeElements(int from, int to)
          Removes elements of this type-specific list using optimised system calls.
 char set(int index, char k)
           
 int size()
           
 void size(int size)
          Sets the size of this list.
 char[] toCharArray(char[] a)
          Builds a primitive type array containing the items of this collection.
 void trim()
          Trims this array list so that the capacity is equal to the size.
 void trim(int n)
          Trims the backing array if it is too large.
static CharArrayList wrap(char[] a)
          Wraps a given array into an array list.
static CharArrayList wrap(char[] a, int length)
          Wraps a given array into an array list of given size.
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharList
add, addAll, addAll, addAll, charIterator, charListIterator, charSubList, compareTo, contains, equals, get, hashCode, indexOf, lastIndexOf, listIterator, listIterator, remove, set, subList, toString
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection
add, contains, containsAll, containsAll, iterator, remove, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toCharArray
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
add, contains, containsAll, iterator, remove, removeAll, retainAll, toArray, toArray
 
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection
containsAll, removeAll, retainAll, toArray, toCharArray
 

Field Detail

DEFAULT_INITIAL_CAPACITY

public static final int DEFAULT_INITIAL_CAPACITY
The initial default capacity of an array list.

See Also:
Constant Field Values

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

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()
Creates a new array list with DEFAULT_INITIAL_CAPACITY capacity.


CharArrayList

public CharArrayList(Collection c)
Creates a new array list and fills it with a given collection.

Parameters:
c - a collection that will be used to fill the array list.

CharArrayList

public CharArrayList(CharCollection c)
Creates a new array list and fills it with a given type-specific collection.

Parameters:
c - a type-specific collection that will be used to fill the array list.

CharArrayList

public CharArrayList(CharList 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(char[] a)
Creates a new array list and fills it with the elements of a given array.


CharArrayList

public CharArrayList(char[] a,
                     int offset,
                     int length)
Creates a new array list and fills it with the elements of a given array.


CharArrayList

public CharArrayList(Iterator 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.

CharArrayList

public CharArrayList(CharIterator i)
Creates a new array list and fills it with the elements returned by a type-specific iterator..

Parameters:
i - a type-specific 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,
                                 int length)
Wraps a given array into an array list of given size.

Parameters:
a - an array to wrap.
Returns:
a new array list of the given size, wrapping the given array.

wrap

public static CharArrayList wrap(char[] a)
Wraps a given array into an array list.

Parameters:
a - an array to wrap.
Returns:
a new array list wrapping the given array.

ensureCapacity

public void ensureCapacity(int capacity)
Ensures that this array list can contain the given number of entries without resizing.

Parameters:
capacity - the new minimum capacity for this array list.

add

public void add(int index,
                char k)
Specified by:
add in interface CharList
Overrides:
add in class AbstractCharList

add

public boolean add(char k)
Specified by:
add in interface CharCollection
Overrides:
add in class AbstractCharCollection

addAll

public boolean addAll(int index,
                      CharCollection c)
Description copied from class: AbstractCharList
Delegates to a more generic method.

Specified by:
addAll in interface CharList
Overrides:
addAll in class AbstractCharList

addAll

public boolean addAll(int index,
                      CharList l)
Description copied from class: AbstractCharList
Delegates to a more generic method.

Specified by:
addAll in interface CharList
Overrides:
addAll in class AbstractCharList

addAll

public boolean addAll(CharList l)
Description copied from class: AbstractCharList
Delegates to a more generic method.

Specified by:
addAll in interface CharList
Overrides:
addAll in class AbstractCharList

getChar

public char getChar(int index)
Specified by:
getChar in interface CharList
See Also:
List.get(int)

indexOf

public int indexOf(char k)
Specified by:
indexOf in interface CharList
Overrides:
indexOf in class AbstractCharList

lastIndexOf

public int lastIndexOf(char k)
Specified by:
lastIndexOf in interface CharList
Overrides:
lastIndexOf in class AbstractCharList

removeChar

public char removeChar(int index)
Specified by:
removeChar in interface CharList
See Also:
List.remove(int)

remove

public boolean remove(char k)
Specified by:
remove in interface CharCollection
Overrides:
remove in class AbstractCharCollection

set

public char set(int index,
                char k)
Specified by:
set in interface CharList
Overrides:
set in class AbstractCharList

clear

public void clear()
Specified by:
clear in interface List

size

public int size()
Specified by:
size in interface List

size

public void size(int size)
Description copied from interface: CharList
Sets the size of this list.

If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/null/false.

Specified by:
size in interface CharList
Overrides:
size in class AbstractCharList

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface List
Overrides:
isEmpty in class AbstractCharCollection

trim

public void trim()
Trims this array list so that the capacity is equal to the size.

See Also:
ArrayList.trimToSize()

trim

public void trim(int n)
Trims the backing array if it is too large. If the current array length is smaller than or equal to n, or if the number of elements is larger than n, this method does nothing. Otherwise, it trims the array length to n.

This method is useful when reusing lists. Clearing a list leaves the array length untouched. If you are reusing a list many times, you can call this method with a typical size to avoid keeping around a very large array just because of a few large transient lists.

Parameters:
n - the threshold for the trimming.

getElements

public void getElements(int from,
                        char[] a,
                        int offset,
                        int length)
Copies element of this type-specific list into the given array using optimised system calls.

Specified by:
getElements in interface CharList
Overrides:
getElements in class AbstractCharList
Parameters:
from - the start index (inclusive).
a - the destination array.
offset - the offset into the destination array where to store the first element copied.
length - the number of elements to be copied.

removeElements

public void removeElements(int from,
                           int to)
Removes elements of this type-specific list using optimised system calls.

Specified by:
removeElements in interface CharList
Overrides:
removeElements in class AbstractCharList
Parameters:
from - the start index (inclusive).
to - the end index (exclusive).

toCharArray

public char[] toCharArray(char[] a)
Description copied from interface: CharCollection
Builds a primitive type array containing the items of this collection.

Specified by:
toCharArray in interface CharCollection
Overrides:
toCharArray in class AbstractCharCollection

charListIterator

public CharListIterator charListIterator(int index)
Description copied from interface: CharList
Returns a type-specific list iterator on the list starting at a given index.

The iterator returned by the List.listIterator() method and by this method are identical; however, using this method you can save a type casting.

Specified by:
charListIterator in interface CharList
See Also:
List.listIterator(int)

clone

public Object clone()

equals

public boolean equals(CharArrayList l)

compareTo

public int compareTo(CharArrayList l)