public abstract class AbstractCharList extends AbstractCharCollection implements CharList, CharStack
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.
Modifier and Type | Class and Description |
---|---|
static class |
AbstractCharList.CharRandomAccessSubList |
static class |
AbstractCharList.CharSubList
A class implementing a sublist view.
|
Modifier and Type | Method and 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(CharCollection c)
Adds all elements of the given type-specific collection to this collection.
|
boolean |
addAll(java.util.Collection<? extends java.lang.Character> c) |
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,
java.util.Collection<? extends java.lang.Character> c)
Adds all of the elements in the specified collection to this 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.
|
void |
clear() |
int |
compareTo(java.util.List<? extends java.lang.Character> l)
Compares this list to another object.
|
boolean |
contains(char k)
Returns true if this list contains the specified element.
|
boolean |
equals(java.lang.Object o) |
void |
forEach(CharConsumer action)
Performs the given action for each element of this type-specific
Iterable
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 to
List.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 |
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.
|
CharList |
subList(int from,
int to)
Returns a type-specific view of the portion of this list from the index
from , inclusive, to the index to , 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[] |
toCharArray()
Returns a primitive type array containing the items of this collection.
|
char |
topChar()
Peeks at the top of the stack (optional operation).
|
java.lang.String |
toString() |
add, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toCharArray
add, add, addAll, addAll, contains, get, getChar, indexOf, lastIndexOf, of, of, of, of, of, remove, remove, replaceAll, replaceAll, replaceAll, set, setElements, setElements, sort, sort, spliterator, unstableSort, unstableSort
containsAll, isEmpty, removeAll, retainAll, size, toArray, toArray
containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toCharArray
forEach, forEach
public void add(int index, char k)
public boolean add(char k)
add
in interface CharCollection
add
in interface CharList
add
in class AbstractCharCollection
Collection.add(Object)
List.add(int, Object)
.public char removeChar(int i)
removeChar
in interface CharList
List.remove(int)
UnsupportedOperationException
.public char set(int index, char k)
public boolean addAll(int index, java.util.Collection<? extends java.lang.Character> c)
addAll
in interface java.util.List<java.lang.Character>
public boolean addAll(java.util.Collection<? extends java.lang.Character> c)
addAll
in interface java.util.Collection<java.lang.Character>
addAll
in interface java.util.List<java.lang.Character>
addAll
in class AbstractCharCollection
List.addAll(int, Collection)
.public CharListIterator iterator()
iterator
in interface CharCollection
iterator
in interface CharIterable
iterator
in interface CharList
iterator
in interface java.lang.Iterable<java.lang.Character>
iterator
in interface java.util.Collection<java.lang.Character>
iterator
in interface java.util.List<java.lang.Character>
iterator
in class AbstractCharCollection
Iterable.iterator()
listIterator()
.public CharListIterator listIterator()
listIterator
in interface CharList
listIterator
in interface java.util.List<java.lang.Character>
List.listIterator()
listIterator(0)
.public CharListIterator listIterator(int index)
listIterator
in interface CharList
listIterator
in interface java.util.List<java.lang.Character>
List.listIterator(int)
public boolean contains(char k)
contains
in interface CharCollection
contains
in class AbstractCharCollection
List.contains(Object)
indexOf()
.public int indexOf(char k)
CharList
public int lastIndexOf(char k)
CharList
lastIndexOf
in interface CharList
List.lastIndexOf(Object)
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
.
public CharList subList(int from, int to)
CharList
from
, inclusive, to the index to
, exclusive.public void forEach(CharConsumer action)
Iterable
until all elements have been processed or the action throws an
exception.forEach
in interface CharIterable
action
- the action to be performed for each element.Iterable.forEach(java.util.function.Consumer)
RandomAccess
, will iterate using a for
loop and the type-specific List.get(int)
method. Otherwise it will fallback
to using the iterator based loop implementation from the superinterface.public void removeElements(int from, int to)
This is a trivial iterator-based based implementation. It is expected that implementations will override this method with a more optimized version.
removeElements
in interface CharList
from
- the start index (inclusive).to
- the end index (exclusive).public void addElements(int index, char[] a, int offset, int length)
This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.
addElements
in interface CharList
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 void addElements(int index, char[] a)
addElements
in interface CharList
index
- the index at which to add elements.a
- the array containing the elements.public void getElements(int from, char[] a, int offset, int length)
This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.
getElements
in interface CharList
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 setElements(int index, char[] a, int offset, int length)
CharList
ListIterator 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.setElements
in interface CharList
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.public void clear()
clear
in interface java.util.Collection<java.lang.Character>
clear
in interface java.util.List<java.lang.Character>
clear
in class java.util.AbstractCollection<java.lang.Character>
removeElements(int, int)
.public int hashCode()
List.hashCode()
.hashCode
in interface java.util.Collection<java.lang.Character>
hashCode
in interface java.util.List<java.lang.Character>
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in interface java.util.Collection<java.lang.Character>
equals
in interface java.util.List<java.lang.Character>
equals
in class java.lang.Object
public int compareTo(java.util.List<? extends java.lang.Character> l)
List
, this method performs a lexicographical comparison; otherwise,
it throws a ClassCastException
.compareTo
in interface java.lang.Comparable<java.util.List<? extends java.lang.Character>>
l
- a list.List
, a negative integer,
zero, or a positive integer as this list is lexicographically less than, equal
to, or greater than the argument.java.lang.ClassCastException
- if the argument is not a list.public void push(char o)
CharStack
push
in interface CharStack
o
- the object to push on the stack.Stack.push(Object)
public char popChar()
CharStack
popChar
in interface CharStack
Stack.pop()
public char topChar()
CharStack
topChar
in interface CharStack
Stack.top()
public char peekChar(int i)
CharStack
peekChar
in interface CharStack
i
- an index from the stop of the stack (0 represents the top).i
-th element on the stack.Stack.peek(int)
public boolean rem(char k)
rem
in interface CharCollection
rem
in class AbstractCharCollection
List.remove(Object)
indexOf()
.public char[] toCharArray()
CharCollection
toCharArray
in interface CharCollection
toCharArray
in class AbstractCharCollection
Collection.toArray()
public char[] toArray(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.
toArray
in interface CharCollection
toArray
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)
CharList
public boolean addAll(CharCollection c)
addAll
in interface CharCollection
addAll
in class AbstractCharCollection
c
- a type-specific collection.true
if this collection changed as a result of the call.Collection.addAll(Collection)
List.addAll(int, Collection)
.public java.lang.String toString()
toString
in class AbstractCharCollection