Class AbstractCharList
- java.lang.Object
-
- java.util.AbstractCollection<Character>
-
- it.unimi.dsi.fastutil.chars.AbstractCharCollection
-
- it.unimi.dsi.fastutil.chars.AbstractCharList
-
- All Implemented Interfaces:
CharCollection
,CharIterable
,CharList
,CharStack
,Stack<Character>
,Comparable<List<? extends Character>>
,Iterable<Character>
,Collection<Character>
,List<Character>
- Direct Known Subclasses:
AbstractCharList.CharSubList
,CharArrayList
,CharLists.Singleton
public abstract class AbstractCharList extends AbstractCharCollection implements CharList, CharStack
An abstract class providing basic methods for lists implementing a type-specific list interface.As an additional bonus, this class implements on top of the list operations a type-specific stack.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AbstractCharList.CharSubList
A class implementing a sublist view.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
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, CharList l)
Inserts all of the elements in the specified type-specific list 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
addAll(CharCollection c)
Adds all elements of the given type-specific collection to this collection.boolean
addAll(CharList l)
Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).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
compareTo(List<? extends Character> l)
Compares this list to another object.boolean
contains(char k)
Returns true if this list contains the specified element.boolean
equals(Object o)
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.CharListIterator
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.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.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
size(int size)
Sets the size of this list.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.char
topChar()
Peeks at the top of the stack (optional operation).String
toString()
-
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection
add, contains, containsAll, remove, removeAll, retainAll, toArray, toCharArray, toCharArray
-
Methods inherited from class java.util.AbstractCollection
containsAll, isEmpty, removeAll, retainAll, size, toArray, toArray
-
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection
containsAll, removeAll, removeIf, removeIf, retainAll, toArray, toCharArray, 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, contains, get, getChar, indexOf, lastIndexOf, remove, remove, set, setElements, setElements, setElements, sort, sort, unstableSort, unstableSort
-
Methods inherited from interface java.util.Collection
parallelStream, stream, toArray
-
Methods inherited from interface java.util.List
containsAll, isEmpty, removeAll, replaceAll, retainAll, size, spliterator, toArray, toArray
-
-
-
-
Method Detail
-
add
public void add(int index, char k)
Inserts the specified element at the specified position in this list (optional operation).This implementation always throws an
UnsupportedOperationException
.- Specified by:
add
in interfaceCharList
- See Also:
List.add(int,Object)
-
add
public boolean add(char k)
Ensures that this collection contains the specified element (optional operation).This implementation always throws an
UnsupportedOperationException
.This implementation delegates to the type-specific version of
List.add(int, Object)
.- Specified by:
add
in interfaceCharCollection
- Specified by:
add
in interfaceCharList
- Overrides:
add
in classAbstractCharCollection
- See Also:
Collection.add(Object)
-
removeChar
public char removeChar(int i)
Removes the element at the specified position in this list (optional operation).This implementation always throws an
UnsupportedOperationException
.- Specified by:
removeChar
in interfaceCharList
- See Also:
List.remove(int)
-
set
public char set(int index, char k)
Replaces the element at the specified position in this list with the specified element (optional operation).This implementation always throws an
UnsupportedOperationException
.- Specified by:
set
in interfaceCharList
- See Also:
List.set(int,Object)
-
addAll
public boolean addAll(int index, Collection<? extends Character> c)
Adds all of the elements in the specified collection to this list (optional operation).
-
addAll
public boolean addAll(Collection<? extends Character> c)
This implementation delegates to the type-specific version of
List.addAll(int, Collection)
.- Specified by:
addAll
in interfaceCollection<Character>
- Specified by:
addAll
in interfaceList<Character>
- Overrides:
addAll
in classAbstractCollection<Character>
-
iterator
public CharListIterator iterator()
Returns a type-specific iterator on the elements of this collection.Note that this specification strengthens the one given in
Iterable.iterator()
, which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extendsCollection
.This implementation delegates to
listIterator()
.- 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:
Iterable.iterator()
-
listIterator
public CharListIterator listIterator()
Returns a type-specific list iterator on the list.This implementation delegates to
listIterator(0)
.- Specified by:
listIterator
in interfaceCharList
- Specified by:
listIterator
in interfaceList<Character>
- See Also:
List.listIterator()
-
listIterator
public CharListIterator listIterator(int index)
Returns a type-specific list iterator on the list starting at a given index.This implementation is based on the random-access methods.
- Specified by:
listIterator
in interfaceCharList
- Specified by:
listIterator
in interfaceList<Character>
- See Also:
List.listIterator(int)
-
contains
public boolean contains(char k)
Returns true if this list contains the specified element.This implementation delegates to
indexOf()
.- Specified by:
contains
in interfaceCharCollection
- Overrides:
contains
in classAbstractCharCollection
- See Also:
List.contains(Object)
-
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.- Specified by:
indexOf
in interfaceCharList
- See Also:
List.indexOf(Object)
-
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:
List.lastIndexOf(Object)
-
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
public CharList subList(int from, int to)
Description copied from interface:CharList
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)
.
-
removeElements
public void removeElements(int from, int to)
Removes (hopefully quickly) elements of 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:
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.This implementation delegates to the analogous method for array fragments.
- Specified by:
addElements
in interfaceCharList
- Parameters:
index
- the index at which to add elements.a
- the array containing the elements.
-
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.
-
clear
public void clear()
This implementation delegates to
removeElements(int, int)
.- Specified by:
clear
in interfaceCollection<Character>
- Specified by:
clear
in interfaceList<Character>
- Overrides:
clear
in classAbstractCollection<Character>
-
hashCode
public int hashCode()
Returns the hash code for this list, which is identical toList.hashCode()
.
-
equals
public boolean equals(Object o)
-
compareTo
public int compareTo(List<? extends Character> l)
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.- Specified by:
push
in interfaceCharStack
- Parameters:
o
- the object to push on the stack.- See Also:
Stack.push(Object)
-
popChar
public char popChar()
Description copied from interface:CharStack
Pops the top off the stack.- Specified by:
popChar
in interfaceCharStack
- Returns:
- the top of the stack.
- See Also:
Stack.pop()
-
topChar
public char topChar()
Description copied from interface:CharStack
Peeks at the top of the stack (optional operation).- Specified by:
topChar
in interfaceCharStack
- Returns:
- the top of the stack.
- See Also:
Stack.top()
-
peekChar
public char peekChar(int i)
Description copied from interface:CharStack
Peeks at an element on the stack (optional operation).- Specified by:
peekChar
in interfaceCharStack
- Parameters:
i
- an index from the stop of the stack (0 represents the top).- Returns:
- the
i
-th element on the stack. - See Also:
Stack.peek(int)
-
rem
public boolean rem(char k)
Removes a single instance of the specified element from this collection, if it is present (optional operation).This implementation delegates to
indexOf()
.- Specified by:
rem
in interfaceCharCollection
- Overrides:
rem
in classAbstractCharCollection
- See Also:
List.remove(Object)
-
addAll
public boolean addAll(int index, CharCollection c)
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).- Specified by:
addAll
in interfaceCharList
- See Also:
List.addAll(int,java.util.Collection)
-
addAll
public boolean addAll(int index, CharList l)
Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).This implementation delegates to the type-specific version of
List.addAll(int, Collection)
.- Specified by:
addAll
in interfaceCharList
- See Also:
List.add(int,Object)
-
addAll
public boolean addAll(CharCollection c)
Adds all elements of the given type-specific collection to this collection.This implementation delegates to the type-specific version of
List.addAll(int, 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:
Collection.addAll(Collection)
-
addAll
public boolean addAll(CharList l)
Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).This implementation delegates to the type-specific list version of
List.addAll(int, Collection)
.- Specified by:
addAll
in interfaceCharList
- See Also:
List.add(int,Object)
-
toString
public String toString()
- Overrides:
toString
in classAbstractCharCollection
-
-