public class CharArrayList extends AbstractCharList implements RandomAccess, Cloneable, Serializable
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.
ArrayList
,
Serialized FormAbstractCharList.CharSubList
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_INITIAL_CAPACITY
The initial default capacity of an array list.
|
Constructor and Description |
---|
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<? extends Character> 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<? extends Character> i)
Creates a new array list and fills it with the elements returned by an iterator..
|
Modifier and Type | Method and Description |
---|---|
boolean |
add(char k) |
void |
add(int index,
char k) |
boolean |
addAll(int index,
CharCollection c)
Delegates to a more generic method.
|
boolean |
addAll(int index,
CharList l)
Delegates to a more generic method.
|
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.
|
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)
Compares this type-specific array list to another one.
|
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 optimized system calls.
|
int |
indexOf(char k) |
boolean |
isEmpty()
Checks whether the stack is empty.
|
int |
lastIndexOf(char k) |
CharListIterator |
listIterator(int index)
Returns a type-specific list iterator on the list starting at a given index.
|
boolean |
rem(char k)
|
char |
removeChar(int index) |
void |
removeElements(int from,
int to)
Removes elements of this type-specific list using optimized system calls.
|
char |
set(int index,
char k) |
int |
size() |
void |
size(int size)
Sets the size of this list.
|
char[] |
toCharArray(char[] a)
Returns 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.
|
add, addAll, addAll, addAll, addAll, addElements, charListIterator, charListIterator, charSubList, compareTo, contains, equals, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, peek, peekChar, pop, popChar, push, push, remove, remove, set, subList, top, topChar, toString
add, charIterator, contains, containsAll, containsAll, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toCharArray
add, contains, containsAll, removeAll, retainAll, toArray, toArray
charIterator, containsAll, removeAll, retainAll, toArray, toArray, toCharArray
public static final int DEFAULT_INITIAL_CAPACITY
public CharArrayList(int capacity)
capacity
- the initial capacity of the array list (may be 0).public CharArrayList()
DEFAULT_INITIAL_CAPACITY
capacity.public CharArrayList(Collection<? extends Character> c)
c
- a collection that will be used to fill the array list.public CharArrayList(CharCollection c)
c
- a type-specific collection that will be used to fill the array list.public CharArrayList(CharList l)
l
- a type-specific list that will be used to fill the array list.public CharArrayList(char[] a)
a
- an array whose elements will be used to fill the array list.public CharArrayList(char[] a, int offset, int length)
a
- an array whose elements will be used to fill the array list.offset
- the first element to use.length
- the number of elements to use.public CharArrayList(Iterator<? extends Character> i)
i
- an iterator whose returned elements will fill the array list.public CharArrayList(CharIterator i)
i
- a type-specific iterator whose returned elements will fill the array list.public char[] elements()
public static CharArrayList wrap(char[] a, int length)
a
- an array to wrap.length
- the length of the resulting array list.public static CharArrayList wrap(char[] a)
a
- an array to wrap.public void ensureCapacity(int capacity)
capacity
- the new minimum capacity for this array list.public void add(int index, char k)
add
in interface CharList
add
in class AbstractCharList
List.add(int,Object)
public boolean add(char k)
add
in interface CharCollection
add
in interface CharList
add
in class AbstractCharList
Collection.add(Object)
public char getChar(int index)
getChar
in interface CharList
List.get(int)
public int indexOf(char k)
indexOf
in interface CharList
indexOf
in class AbstractCharList
List.indexOf(Object)
public int lastIndexOf(char k)
lastIndexOf
in interface CharList
lastIndexOf
in class AbstractCharList
List.lastIndexOf(Object)
public char removeChar(int index)
removeChar
in interface CharList
removeChar
in class AbstractCharList
List.remove(int)
public boolean rem(char k)
CharCollection
remove()
, but the clash
with the similarly named index-based method in the List
interface
forces us to use a distinguished name. For simplicity, the set interfaces reinstates
remove()
.rem
in interface CharCollection
rem
in class AbstractCharList
Collection.remove(Object)
public char set(int index, char k)
set
in interface CharList
set
in class AbstractCharList
List.set(int,Object)
public void clear()
clear
in interface Collection<Character>
clear
in interface List<Character>
clear
in class AbstractCollection<Character>
public int size()
size
in interface Collection<Character>
size
in interface List<Character>
size
in class AbstractCollection<Character>
public void size(int size)
CharList
If the specified size is smaller than the current size, the last elements are
discarded. Otherwise, they are filled with 0/null
/false
.
size
in interface CharList
size
in class AbstractCharList
size
- the new size.public boolean isEmpty()
Stack
public void trim()
ArrayList.trimToSize()
public void trim(int n)
n
, this method does nothing. Otherwise, it trims the
array length to the maximum between n
and size()
.
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.
n
- the threshold for the trimming.public void getElements(int from, char[] a, int offset, int length)
getElements
in interface CharList
getElements
in class AbstractCharList
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.public void removeElements(int from, int to)
removeElements
in interface CharList
removeElements
in class AbstractCharList
from
- the start index (inclusive).to
- the end index (exclusive).public void addElements(int index, char[] a, int offset, int length)
addElements
in interface CharList
addElements
in class AbstractCharList
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.public char[] toCharArray(char[] a)
CharCollection
Note that, contrarily to Collection.toArray(Object[])
, this
methods just writes all elements of this collection: no special
value will be added after the last one.
toCharArray
in interface CharCollection
toCharArray
in class AbstractCharCollection
a
- if this array is big enough, it will be used to store this collection.Collection.toArray(Object[])
public boolean addAll(int index, CharCollection c)
AbstractCharList
addAll
in interface CharList
addAll
in class AbstractCharList
List.add(int,Object)
public boolean addAll(int index, CharList l)
AbstractCharList
addAll
in interface CharList
addAll
in class AbstractCharList
List.add(int,Object)
public CharListIterator listIterator(int index)
CharList
listIterator
in interface CharList
listIterator
in interface List<Character>
listIterator
in class AbstractCharList
List.listIterator(int)
public CharArrayList clone()
public boolean equals(CharArrayList l)
This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
l
- a type-specific array list.public int compareTo(CharArrayList l)
This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
l
- an array list.