Class AbstractCharList
- All Implemented Interfaces:
CharCollection
,CharIterable
,CharList
,CharStack
,Stack<Character>
,Comparable<List<? extends Character>>
,Iterable<Character>
,Collection<Character>
,List<Character>
,SequencedCollection<Character>
- Direct Known Subclasses:
AbstractCharList.CharSubList
,CharArrayList
,CharImmutableList
,CharLists.Singleton
As an additional bonus, this class implements on top of the list operations a type-specific stack.
Most of the methods in this class are optimized with the assumption that the List will have
have constant-time random access
. If this is not the case, you
should probably at least override listIterator(int)
and the xAll()
methods (such as addAll(int, java.util.Collection<? extends java.lang.Character>)
) with a more appropriate iteration scheme. Note the
subList(int, int)
method is cognizant of random-access or not, so that need not be
reimplemented.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
A class implementing a sublist view. -
Method Summary
Modifier and TypeMethodDescriptionboolean
add
(char k) Ensures that this collection contains the specified element (optional operation).void
add
(int index, char k) Inserts the specified element at the specified position in this list (optional operation).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, Collection<? extends Character> c) Adds all of the elements in the specified collection to this list (optional operation).boolean
Adds all elements of the given type-specific collection to this collection.boolean
addAll
(Collection<? extends Character> c) 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.void
clear()
int
Compares this list to another object.boolean
contains
(char k) Returns true if this list contains the specified element.boolean
void
forEach
(CharConsumer action) Performs the given action for each element of this type-specificIterable
until all elements have been processed or the action throws an exception.void
getElements
(int from, char[] a, int offset, int length) Copies (hopefully quickly) elements of this type-specific list into the given array.int
hashCode()
Returns the hash code for this list, which is identical toList.hashCode()
.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.iterator()
Returns a type-specific iterator on the elements of this collection.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.Returns a type-specific list iterator on the list.listIterator
(int index) Returns a type-specific list iterator on the list starting at a given index.char
peekChar
(int i) Peeks at an element on the stack (optional operation).char
popChar()
Pops the top off the stack.void
push
(char o) Pushes the given object on the stack.boolean
rem
(char k) Removes a single instance of the specified element from this collection, if it is present (optional operation).char
removeChar
(int i) 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).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.subList
(int from, int to) Returns a type-specific view of the portion of this list from the indexfrom
, inclusive, to the indexto
, exclusive.char[]
toArray
(char[] a) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.char[]
Returns a primitive type array containing the items of this collection.char
topChar()
Peeks at the top of the stack (optional operation).toString()
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection
add, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toCharArray
Methods inherited from class java.util.AbstractCollection
isEmpty, size, toArray, toArray
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection
containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, spliterator, stream, toCharArray
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable
forEach, forEach
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharList
add, add, addAll, addAll, contains, get, getChar, indexOf, lastIndexOf, remove, remove, replaceAll, replaceAll, replaceAll, set, setElements, setElements, sort, sort, spliterator, unstableSort, unstableSort
Methods inherited from interface java.util.Collection
toArray
Methods inherited from interface java.util.List
addFirst, addLast, containsAll, getFirst, getLast, isEmpty, removeAll, removeFirst, removeLast, retainAll, reversed, size, toArray, toArray
-
Method Details
-
add
public void add(int index, char k) Inserts the specified element at the specified position in this list (optional operation).- Specified by:
add
in interfaceCharList
- See Also:
- Implementation Specification:
- This implementation always throws an
UnsupportedOperationException
.
-
add
public boolean add(char k) Ensures that this collection contains the specified element (optional operation).- Specified by:
add
in interfaceCharCollection
- Specified by:
add
in interfaceCharList
- Overrides:
add
in classAbstractCharCollection
- See Also:
- Implementation Specification:
- This implementation delegates to the type-specific version of
List.add(int, Object)
.
-
removeChar
public char removeChar(int i) Removes the element at the specified position in this list (optional operation).- Specified by:
removeChar
in interfaceCharList
- See Also:
- Implementation Specification:
- This implementation always throws an
UnsupportedOperationException
.
-
set
public char set(int index, char k) Replaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
set
in interfaceCharList
- See Also:
- Implementation Specification:
- This implementation always throws an
UnsupportedOperationException
.
-
addAll
Adds all of the elements in the specified collection to this list (optional operation). -
addAll
- Specified by:
addAll
in interfaceCollection<Character>
- Specified by:
addAll
in interfaceList<Character>
- Overrides:
addAll
in classAbstractCharCollection
- Implementation Specification:
- This implementation delegates to the type-specific version of
List.addAll(int, Collection)
.
-
iterator
Returns a type-specific iterator on the elements of this collection.- Specified by:
iterator
in interfaceCharCollection
- Specified by:
iterator
in interfaceCharIterable
- Specified by:
iterator
in interfaceCharList
- Specified by:
iterator
in interfaceCollection<Character>
- Specified by:
iterator
in interfaceIterable<Character>
- Specified by:
iterator
in interfaceList<Character>
- Specified by:
iterator
in classAbstractCharCollection
- Returns:
- a type-specific iterator on the elements of this collection.
- See Also:
- Implementation Specification:
- This implementation delegates to
listIterator()
.
-
listIterator
Returns a type-specific list iterator on the list.- Specified by:
listIterator
in interfaceCharList
- Specified by:
listIterator
in interfaceList<Character>
- See Also:
- Implementation Specification:
- This implementation delegates to
listIterator(0)
.
-
listIterator
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>
- See Also:
- Implementation Specification:
- This implementation is based on the random-access methods.
-
contains
public boolean contains(char k) Returns true if this list contains the specified element.- Specified by:
contains
in interfaceCharCollection
- Overrides:
contains
in classAbstractCharCollection
- See Also:
- Implementation Specification:
- This implementation delegates to
indexOf()
.
-
indexOf
public int indexOf(char k) Description copied from interface:CharList
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. -
lastIndexOf
public int lastIndexOf(char k) Description copied from interface:CharList
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
lastIndexOf
in interfaceCharList
- See Also:
-
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
. -
subList
Description copied from interface:CharList
Returns a type-specific view of the portion of this list from the indexfrom
, inclusive, to the indexto
, exclusive. -
forEach
Performs the given action for each element of this type-specificIterable
until all elements have been processed or the action throws an exception.- Specified by:
forEach
in interfaceCharIterable
- Parameters:
action
- the action to be performed for each element.- See Also:
- Implementation Specification:
- If this list is
RandomAccess
, will iterate using a for loop and the type-specificList.get(int)
method. Otherwise it will fallback to using the iterator based loop implementation from the superinterface.
-
removeElements
public void removeElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.This is a trivial iterator-based based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
removeElements
in interfaceCharList
- Parameters:
from
- the start index (inclusive).to
- the end index (exclusive).
-
addElements
public void addElements(int index, char[] a, int offset, int length) Add (hopefully quickly) elements to this type-specific list.This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
addElements
in interfaceCharList
- 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.
-
addElements
public void addElements(int index, char[] a) Add (hopefully quickly) elements to this type-specific list.- Specified by:
addElements
in interfaceCharList
- Parameters:
index
- the index at which to add elements.a
- the array containing the elements.- Implementation Specification:
- This implementation delegates to the analogous method for array fragments.
-
getElements
public void getElements(int from, char[] a, int offset, int length) Copies (hopefully quickly) elements of this type-specific list into the given array.This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
getElements
in interfaceCharList
- 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.
-
setElements
public void setElements(int index, char[] a, int offset, int length) Description copied from interface:CharList
Set (hopefully quickly) elements to match the array given. Sets each in this list to the corresponding elements in the array, as if byListIterator iter = listIterator(index); int i = 0; while (i < length) { iter.next(); iter.set(a[offset + i++]); }
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.- Specified by:
setElements
in interfaceCharList
- 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.
-
clear
public void clear()- Specified by:
clear
in interfaceCollection<Character>
- Specified by:
clear
in interfaceList<Character>
- Overrides:
clear
in classAbstractCollection<Character>
- Implementation Specification:
- This implementation delegates to
removeElements(int, int)
.
-
hashCode
public int hashCode()Returns the hash code for this list, which is identical toList.hashCode()
. -
equals
-
compareTo
Compares this list to another object. If the argument is aList
, this method performs a lexicographical comparison; otherwise, it throws aClassCastException
.- Specified by:
compareTo
in interfaceComparable<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.
-
push
public void push(char o) Description copied from interface:CharStack
Pushes the given object on the stack. -
popChar
public char popChar()Description copied from interface:CharStack
Pops the top off the stack. -
topChar
public char topChar()Description copied from interface:CharStack
Peeks at the top of the stack (optional operation). -
peekChar
public char peekChar(int i) Description copied from interface:CharStack
Peeks at an element on the stack (optional operation). -
rem
public boolean rem(char k) Removes a single instance of the specified element from this collection, if it is present (optional operation).- Specified by:
rem
in interfaceCharCollection
- Overrides:
rem
in classAbstractCharCollection
- See Also:
- Implementation Specification:
- This implementation delegates to
indexOf()
.
-
toCharArray
public char[] toCharArray()Description copied from interface:CharCollection
Returns a primitive type array containing the items of this collection.- Specified by:
toCharArray
in interfaceCharCollection
- Overrides:
toCharArray
in classAbstractCharCollection
- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
toArray
public char[] toArray(char[] a) Description copied from interface:CharCollection
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.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:
toArray
in interfaceCharCollection
- Overrides:
toArray
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:
-
addAll
Description copied from interface:CharList
Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation). -
addAll
Adds all elements of the given type-specific collection to this collection.- Specified by:
addAll
in interfaceCharCollection
- Overrides:
addAll
in classAbstractCharCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
- Implementation Specification:
- This implementation delegates to the type-specific version of
List.addAll(int, Collection)
.
-
toString
- Overrides:
toString
in classAbstractCharCollection
-