Interface CharList
-
- All Superinterfaces:
CharCollection
,CharIterable
,Collection<Character>
,Comparable<List<? extends Character>>
,Iterable<Character>
,List<Character>
- All Known Implementing Classes:
AbstractCharList
,AbstractCharList.CharSubList
,CharArrayList
,CharLists.EmptyList
,CharLists.Singleton
,CharLists.SynchronizedList
,CharLists.SynchronizedRandomAccessList
,CharLists.UnmodifiableList
,CharLists.UnmodifiableRandomAccessList
public interface CharList extends List<Character>, Comparable<List<? extends Character>>, CharCollection
A type-specificList
; provides some additional methods that use polymorphism to avoid (un)boxing.Note that this type-specific interface extends
Comparable
: it is expected that implementing classes perform a lexicographical comparison using the standard operator "less then" for primitive types, and the usualcompareTo()
method for objects.Additionally, this interface strengthens
listIterator()
,listIterator(int)
andsubList(int,int)
.Besides polymorphic methods, this interfaces specifies methods to copy into an array or remove contiguous sublists. Although the abstract implementation of this interface provides simple, one-by-one implementations of these methods, it is expected that concrete implementation override them with optimized versions.
- See Also:
List
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description boolean
add(char key)
Appends the specified element to the end of this list (optional operation).void
add(int index, char key)
Inserts the specified element at the specified position in this list (optional operation).default void
add(int index, Character key)
Deprecated.Please use the corresponding type-specific method instead.default boolean
add(Character k)
Deprecated.Please use the corresponding type-specific method instead.boolean
addAll(int index, CharCollection c)
Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).boolean
addAll(int index, CharList c)
Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).boolean
addAll(CharList c)
Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).void
addElements(int index, char[] a)
Add (hopefully quickly) elements to this type-specific list.void
addElements(int index, char[] a, int offset, int length)
Add (hopefully quickly) elements to this type-specific list.default boolean
contains(Object key)
Deprecated.Please use the corresponding type-specific method instead.default Character
get(int index)
Deprecated.Please use the corresponding type-specific method instead.char
getChar(int index)
Returns the element at the specified position in this list.void
getElements(int from, char[] a, int offset, int length)
Copies (hopefully quickly) elements of this type-specific list into the given array.int
indexOf(char k)
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.default int
indexOf(Object o)
Deprecated.Please use the corresponding type-specific method instead.CharListIterator
iterator()
Returns a type-specific iterator on the elements of this list.int
lastIndexOf(char k)
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.default int
lastIndexOf(Object o)
Deprecated.Please use the corresponding type-specific method instead.CharListIterator
listIterator()
Returns a type-specific list iterator on the list.CharListIterator
listIterator(int index)
Returns a type-specific list iterator on the list starting at a given index.static CharList
of(char... init)
Creates an array list using a list of elements.default Character
remove(int index)
Deprecated.Please use the corresponding type-specific method instead.default boolean
remove(Object key)
Deprecated.Please use the corresponding type-specific method instead.char
removeChar(int index)
Removes the element at the specified position in this list (optional operation).void
removeElements(int from, int to)
Removes (hopefully quickly) elements of this type-specific list.char
set(int index, char k)
Replaces the element at the specified position in this list with the specified element (optional operation).default Character
set(int index, Character k)
Deprecated.Please use the corresponding type-specific method instead.default void
setElements(char[] a)
Set (hopefully quickly) elements to match the array given.default void
setElements(int index, char[] a)
Set (hopefully quickly) elements to match the array given.default void
setElements(int index, char[] a, int offset, int length)
Set (hopefully quickly) elements to match the array given.void
size(int size)
Sets the size of this list.default void
sort(CharComparator comparator)
Sort a list using a type-specific comparator.default void
sort(Comparator<? super Character> comparator)
Deprecated.Please use the corresponding type-specific method instead.CharList
subList(int from, int to)
Returns a type-specific view of the portion of this list from the indexfrom
, inclusive, to the indexto
, exclusive.default void
unstableSort(CharComparator comparator)
Sorts this list using a sort not assured to be stable.default void
unstableSort(Comparator<? super Character> comparator)
Deprecated.Please use the corresponding type-specific method instead.-
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection
addAll, contains, containsAll, rem, removeAll, removeIf, removeIf, retainAll, toArray, toCharArray, toCharArray
-
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable
forEach, forEach
-
Methods inherited from interface java.util.Collection
parallelStream, stream, toArray
-
Methods inherited from interface java.lang.Comparable
compareTo
-
Methods inherited from interface java.util.List
addAll, addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, replaceAll, retainAll, size, spliterator, toArray, toArray
-
-
-
-
Method Detail
-
iterator
CharListIterator iterator()
Returns a type-specific iterator on the elements of this list.Note that this specification strengthens the one given in
List.iterator()
. It would not be normally necessary, butIterable.iterator()
is bizarrily re-specified inList
.- Specified by:
iterator
in interfaceCharCollection
- Specified by:
iterator
in interfaceCharIterable
- Specified by:
iterator
in interfaceCollection<Character>
- Specified by:
iterator
in interfaceIterable<Character>
- Specified by:
iterator
in interfaceList<Character>
- Returns:
- an iterator on the elements of this list.
- See Also:
Iterable.iterator()
-
listIterator
CharListIterator listIterator()
Returns a type-specific list iterator on the list.- Specified by:
listIterator
in interfaceList<Character>
- See Also:
List.listIterator()
-
listIterator
CharListIterator listIterator(int index)
Returns a type-specific list iterator on the list starting at a given index.- Specified by:
listIterator
in interfaceList<Character>
- See Also:
List.listIterator(int)
-
subList
CharList subList(int from, int to)
Returns a type-specific view of the portion of this list from the indexfrom
, inclusive, to the indexto
, exclusive.Note that this specification strengthens the one given in
List.subList(int,int)
.- Specified by:
subList
in interfaceList<Character>
- See Also:
List.subList(int,int)
-
size
void size(int size)
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
.- Parameters:
size
- the new size.
-
getElements
void getElements(int from, char[] a, int offset, int length)
Copies (hopefully quickly) elements of this type-specific list into the given array.- 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
void removeElements(int from, int to)
Removes (hopefully quickly) elements of this type-specific list.- Parameters:
from
- the start index (inclusive).to
- the end index (exclusive).
-
addElements
void addElements(int index, char[] a)
Add (hopefully quickly) elements to this type-specific list.- Parameters:
index
- the index at which to add elements.a
- the array containing the elements.
-
addElements
void addElements(int index, char[] a, int offset, int length)
Add (hopefully quickly) elements to this type-specific list.- 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.
-
setElements
default void setElements(char[] a)
Set (hopefully quickly) elements to match the array given.- Parameters:
a
- the array containing the elements.- Since:
- 8.3.0
-
setElements
default void setElements(int index, char[] a)
Set (hopefully quickly) elements to match the array given.- Parameters:
index
- the index at which to start setting elements.a
- the array containing the elements.- Since:
- 8.3.0
-
setElements
default void setElements(int index, char[] a, int offset, int length)
Set (hopefully quickly) elements to match the array given. Sets each in this list to the corresponding elements in the array, as if by
However, the exact implementation may be more efficient, taking into account whether random access is faster or not, or at the discretion of subclasses, abuse internals.ListIterator iter = listIterator(index); int i = 0; while (i < length) { iter.next(); iter.set(a[offset + i++]); }
- Parameters:
index
- the index at which to start setting elements.a
- the array containing the elementsoffset
- the offset of the first element to add.length
- the number of elements to add.- Since:
- 8.3.0
-
add
boolean add(char key)
Appends the specified element to the end of this list (optional operation).- Specified by:
add
in interfaceCharCollection
- See Also:
List.add(Object)
-
add
void add(int index, char key)
Inserts the specified element at the specified position in this list (optional operation).- See Also:
List.add(int,Object)
-
add
@Deprecated default void add(int index, Character key)
Deprecated.Please use the corresponding type-specific method instead.
-
addAll
boolean addAll(int index, CharCollection c)
Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).- See Also:
List.addAll(int,java.util.Collection)
-
addAll
boolean addAll(int index, CharList c)
Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).- See Also:
List.add(int,Object)
-
addAll
boolean addAll(CharList c)
Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).- See Also:
List.add(int,Object)
-
set
char set(int index, char k)
Replaces the element at the specified position in this list with the specified element (optional operation).- See Also:
List.set(int,Object)
-
getChar
char getChar(int index)
Returns the element at the specified position in this list.- See Also:
List.get(int)
-
indexOf
int indexOf(char k)
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.- See Also:
List.indexOf(Object)
-
lastIndexOf
int lastIndexOf(char k)
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.- See Also:
List.lastIndexOf(Object)
-
contains
@Deprecated default boolean contains(Object key)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
contains
in interfaceCharCollection
- Specified by:
contains
in interfaceCollection<Character>
- Specified by:
contains
in interfaceList<Character>
-
get
@Deprecated default Character get(int index)
Deprecated.Please use the corresponding type-specific method instead.
-
indexOf
@Deprecated default int indexOf(Object o)
Deprecated.Please use the corresponding type-specific method instead.
-
lastIndexOf
@Deprecated default int lastIndexOf(Object o)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
lastIndexOf
in interfaceList<Character>
-
add
@Deprecated default boolean add(Character k)
Deprecated.Please use the corresponding type-specific method instead.This method specification is a workaround for bug 8177440.
- Specified by:
add
in interfaceCharCollection
- Specified by:
add
in interfaceCollection<Character>
- Specified by:
add
in interfaceList<Character>
-
removeChar
char removeChar(int index)
Removes the element at the specified position in this list (optional operation).- See Also:
List.remove(int)
-
remove
@Deprecated default boolean remove(Object key)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
remove
in interfaceCharCollection
- Specified by:
remove
in interfaceCollection<Character>
- Specified by:
remove
in interfaceList<Character>
-
remove
@Deprecated default Character remove(int index)
Deprecated.Please use the corresponding type-specific method instead.
-
set
@Deprecated default Character set(int index, Character k)
Deprecated.Please use the corresponding type-specific method instead.
-
of
@SafeVarargs static CharList of(char... init)
Creates an array list using a list of elements.- Parameters:
init
- a list of elements that will be used to initialize the list.- Returns:
- a new array list containing the given elements.
-
sort
@Deprecated default void sort(Comparator<? super Character> comparator)
Deprecated.Please use the corresponding type-specific method instead.
-
sort
default void sort(CharComparator comparator)
Sort a list using a type-specific comparator.Pass
null
to sort using natural ordering.- Since:
- 8.3.0
- See Also:
List.sort(java.util.Comparator)
- Implementation Notes:
- The default implementation dumps the elements into an array using
List.toArray()
, sorts the array, then replaces all elements using thesetElements(char[])
function.It is possible for this method to call
unstableSort(java.util.Comparator<? super java.lang.Character>)
if it can determine that the results of a stable and unstable sort are completely equivalent. This means if you overrideunstableSort(java.util.Comparator<? super java.lang.Character>)
, it should not call this method unless you override this method as well.
-
unstableSort
@Deprecated default void unstableSort(Comparator<? super Character> comparator)
Deprecated.Please use the corresponding type-specific method instead.Sorts this list using a sort not assured to be stable.
-
unstableSort
default void unstableSort(CharComparator comparator)
Sorts this list using a sort not assured to be stable.Pass
null
to sort using natural ordering.This differs from
List.sort(java.util.Comparator)
in that the results are not assured to be stable, but may be a bit faster.Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.
- Since:
- 8.3.0
- Implementation Notes:
- The default implementation dumps the elements into an array using
List.toArray()
, sorts the array, then replaces all elements using thesetElements(char[])
function.
-
-