Class CharArrayList
- java.lang.Object
-
- java.util.AbstractCollection<Character>
-
- org.codelibs.jhighlight.fastutil.chars.AbstractCharCollection
-
- org.codelibs.jhighlight.fastutil.chars.AbstractCharList
-
- org.codelibs.jhighlight.fastutil.chars.CharArrayList
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<List<? extends Character>>
,Iterable<Character>
,Collection<Character>
,List<Character>
,RandomAccess
,CharCollection
,CharIterable
,CharList
,CharStack
,Stack<Character>
public class CharArrayList extends AbstractCharList implements RandomAccess, Cloneable, Serializable
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 ofjava.util
's classes, but they are delayed as much as possible. The backing array is exposed by theelements()
method.This class implements the bulk methods
removeElements()
,addElements()
andgetElements()
using high-performance system calls (e.g.,System.arraycopy()
instead of expensive loops.- See Also:
ArrayList
, Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.codelibs.jhighlight.fastutil.chars.AbstractCharList
AbstractCharList.CharSubList
-
-
Field Summary
Fields Modifier and Type Field Description protected char[]
a
The backing array.static int
DEFAULT_INITIAL_CAPACITY
The initial default capacity of an array list.protected int
size
The current actual size of the list (never greater than the backing-array length).
-
Constructor Summary
Constructors Modifier Constructor Description CharArrayList()
Creates a new array list withDEFAULT_INITIAL_CAPACITY
capacity.CharArrayList(char[] a)
Creates a new array list and fills it with the elements of a given array.protected
CharArrayList(char[] a, boolean dummy)
Creates a new array list using 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(int capacity)
Creates a new array list with given capacity.CharArrayList(Collection<? extends Character> c)
Creates a new array list and fills it with a given collection.CharArrayList(Iterator<? extends Character> i)
Creates a new array list and fills it with the elements returned by an iterator..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.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.-
Methods inherited from class org.codelibs.jhighlight.fastutil.chars.AbstractCharList
add, addAll, addAll, addAll, addAll, addElements, charListIterator, charListIterator, charSubList, compareTo, contains, ensureIndex, ensureRestrictedIndex, equals, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, peek, peekChar, pop, popChar, push, push, remove, remove, set, subList, top, topChar, toString
-
Methods inherited from class org.codelibs.jhighlight.fastutil.chars.AbstractCharCollection
add, charIterator, contains, containsAll, containsAll, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toCharArray
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.codelibs.jhighlight.fastutil.chars.CharCollection
charIterator, containsAll, removeAll, retainAll, toArray, toArray, toCharArray
-
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray
-
Methods inherited from interface java.util.List
add, contains, containsAll, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray
-
-
-
-
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
-
a
protected transient char[] a
The backing array.
-
size
protected int size
The current actual size of the list (never greater than the backing-array length).
-
-
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()
Creates a new array list withDEFAULT_INITIAL_CAPACITY
capacity.
-
CharArrayList
public CharArrayList(Collection<? extends Character> 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.- Parameters:
a
- an array whose elements will be used to fill the array list.
-
CharArrayList
public CharArrayList(char[] a, int offset, int length)
Creates a new array list and fills it with the elements of a given array.- Parameters:
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.
-
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.
-
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.length
- the length of the resulting array list.- 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 interfaceCharList
- Overrides:
add
in classAbstractCharList
- See Also:
List.add(int,Object)
-
add
public boolean add(char k)
- Specified by:
add
in interfaceCharCollection
- Specified by:
add
in interfaceCharList
- Overrides:
add
in classAbstractCharList
- See Also:
Collection.add(Object)
-
getChar
public char getChar(int index)
- Specified by:
getChar
in interfaceCharList
- See Also:
List.get(int)
-
indexOf
public int indexOf(char k)
- Specified by:
indexOf
in interfaceCharList
- Overrides:
indexOf
in classAbstractCharList
- See Also:
List.indexOf(Object)
-
lastIndexOf
public int lastIndexOf(char k)
- Specified by:
lastIndexOf
in interfaceCharList
- Overrides:
lastIndexOf
in classAbstractCharList
- See Also:
List.lastIndexOf(Object)
-
removeChar
public char removeChar(int index)
- Specified by:
removeChar
in interfaceCharList
- Overrides:
removeChar
in classAbstractCharList
- See Also:
List.remove(int)
-
rem
public boolean rem(char k)
Description copied from interface:CharCollection
Note that this method should be calledremove()
, but the clash with the similarly named index-based method in theList
interface forces us to use a distinguished name. For simplicity, the set interfaces reinstatesremove()
.- Specified by:
rem
in interfaceCharCollection
- Overrides:
rem
in classAbstractCharList
- See Also:
Collection.remove(Object)
-
set
public char set(int index, char k)
- Specified by:
set
in interfaceCharList
- Overrides:
set
in classAbstractCharList
- See Also:
List.set(int,Object)
-
clear
public void clear()
- Specified by:
clear
in interfaceCollection<Character>
- Specified by:
clear
in interfaceList<Character>
- Overrides:
clear
in classAbstractCollection<Character>
-
size
public int size()
- Specified by:
size
in interfaceCollection<Character>
- Specified by:
size
in interfaceList<Character>
- Specified by:
size
in classAbstractCollection<Character>
-
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 interfaceCharList
- Overrides:
size
in classAbstractCharList
- Parameters:
size
- the new size.
-
isEmpty
public boolean isEmpty()
Description copied from interface:Stack
Checks whether the stack is empty.
-
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 ton
, this method does nothing. Otherwise, it trims the array length to the maximum betweenn
andsize()
.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 optimized system calls.- Specified by:
getElements
in interfaceCharList
- Overrides:
getElements
in classAbstractCharList
- 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 optimized system calls.- Specified by:
removeElements
in interfaceCharList
- Overrides:
removeElements
in classAbstractCharList
- 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.- Specified by:
addElements
in interfaceCharList
- Overrides:
addElements
in classAbstractCharList
- 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.
-
toCharArray
public char[] toCharArray(char[] a)
Description copied from interface:CharCollection
Returns a primitive type array containing the items of this collection.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.- Specified by:
toCharArray
in interfaceCharCollection
- Overrides:
toCharArray
in classAbstractCharCollection
- Parameters:
a
- if this array is big enough, it will be used to store this collection.- Returns:
- a primitive type array containing the items of this collection.
- See Also:
Collection.toArray(Object[])
-
addAll
public boolean addAll(int index, CharCollection c)
Description copied from class:AbstractCharList
Delegates to a more generic method.- Specified by:
addAll
in interfaceCharList
- Overrides:
addAll
in classAbstractCharList
- See Also:
List.add(int,Object)
-
addAll
public boolean addAll(int index, CharList l)
Description copied from class:AbstractCharList
Delegates to a more generic method.- Specified by:
addAll
in interfaceCharList
- Overrides:
addAll
in classAbstractCharList
- See Also:
List.add(int,Object)
-
listIterator
public CharListIterator listIterator(int index)
Description copied from interface:CharList
Returns a type-specific list iterator on the list starting at a given index.- Specified by:
listIterator
in interfaceCharList
- Specified by:
listIterator
in interfaceList<Character>
- Overrides:
listIterator
in classAbstractCharList
- See Also:
List.listIterator(int)
-
clone
public CharArrayList clone()
-
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.
-
-