public abstract class AbstractByteList extends AbstractByteCollection implements ByteList, ByteStack
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.Byte>)
) 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 |
AbstractByteList.ByteRandomAccessSubList |
static class |
AbstractByteList.ByteSubList
A class implementing a sublist view.
|
Modifier and Type | Method and Description |
---|---|
boolean |
add(byte k)
Ensures that this collection contains the specified element (optional operation).
|
void |
add(int index,
byte k)
Inserts the specified element at the specified position in this list (optional operation).
|
boolean |
addAll(ByteCollection c)
Adds all elements of the given type-specific collection to this collection.
|
boolean |
addAll(java.util.Collection<? extends java.lang.Byte> c) |
boolean |
addAll(int index,
ByteCollection 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.Byte> c)
Adds all of the elements in the specified collection to this list (optional operation).
|
void |
addElements(int index,
byte[] a)
Add (hopefully quickly) elements to this type-specific list.
|
void |
addElements(int index,
byte[] a,
int offset,
int length)
Add (hopefully quickly) elements to this type-specific list.
|
void |
clear() |
int |
compareTo(java.util.List<? extends java.lang.Byte> l)
Compares this list to another object.
|
boolean |
contains(byte k)
Returns true if this list contains the specified element.
|
boolean |
equals(java.lang.Object o) |
void |
forEach(ByteConsumer 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,
byte[] 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(byte 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.
|
ByteListIterator |
iterator()
Returns a type-specific iterator on the elements of this collection.
|
int |
lastIndexOf(byte 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.
|
ByteListIterator |
listIterator()
Returns a type-specific list iterator on the list.
|
ByteListIterator |
listIterator(int index)
Returns a type-specific list iterator on the list starting at a given index.
|
byte |
peekByte(int i)
Peeks at an element on the stack (optional operation).
|
byte |
popByte()
Pops the top off the stack.
|
void |
push(byte o)
Pushes the given object on the stack.
|
boolean |
rem(byte k)
Removes a single instance of the specified element from this collection, if it is present (optional operation).
|
byte |
removeByte(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.
|
byte |
set(int index,
byte k)
Replaces the element at the specified position in this list with the specified element (optional operation).
|
void |
setElements(int index,
byte[] a,
int offset,
int length)
Set (hopefully quickly) elements to match the array given.
|
void |
size(int size)
Sets the size of this list.
|
ByteList |
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. |
byte[] |
toArray(byte[] 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.
|
byte[] |
toByteArray()
Returns a primitive type array containing the items of this collection.
|
byte |
topByte()
Peeks at the top of the stack (optional operation).
|
java.lang.String |
toString() |
add, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toByteArray
add, add, addAll, addAll, contains, get, getByte, 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, toByteArray
forEach, forEach
public void add(int index, byte k)
public boolean add(byte k)
add
in interface ByteCollection
add
in interface ByteList
add
in class AbstractByteCollection
Collection.add(Object)
List.add(int, Object)
.public byte removeByte(int i)
removeByte
in interface ByteList
List.remove(int)
UnsupportedOperationException
.public byte set(int index, byte k)
public boolean addAll(int index, java.util.Collection<? extends java.lang.Byte> c)
addAll
in interface java.util.List<java.lang.Byte>
public boolean addAll(java.util.Collection<? extends java.lang.Byte> c)
addAll
in interface java.util.Collection<java.lang.Byte>
addAll
in interface java.util.List<java.lang.Byte>
addAll
in class AbstractByteCollection
List.addAll(int, Collection)
.public ByteListIterator iterator()
iterator
in interface ByteCollection
iterator
in interface ByteIterable
iterator
in interface ByteList
iterator
in interface java.lang.Iterable<java.lang.Byte>
iterator
in interface java.util.Collection<java.lang.Byte>
iterator
in interface java.util.List<java.lang.Byte>
iterator
in class AbstractByteCollection
Iterable.iterator()
listIterator()
.public ByteListIterator listIterator()
listIterator
in interface ByteList
listIterator
in interface java.util.List<java.lang.Byte>
List.listIterator()
listIterator(0)
.public ByteListIterator listIterator(int index)
listIterator
in interface ByteList
listIterator
in interface java.util.List<java.lang.Byte>
List.listIterator(int)
public boolean contains(byte k)
contains
in interface ByteCollection
contains
in class AbstractByteCollection
List.contains(Object)
indexOf()
.public int indexOf(byte k)
ByteList
public int lastIndexOf(byte k)
ByteList
lastIndexOf
in interface ByteList
List.lastIndexOf(Object)
public void size(int size)
ByteList
If the specified size is smaller than the current size, the last elements are
discarded. Otherwise, they are filled with 0/null
/false
.
public ByteList subList(int from, int to)
ByteList
from
, inclusive, to the index to
, exclusive.public void forEach(ByteConsumer action)
Iterable
until all elements have been processed or the action throws an
exception.forEach
in interface ByteIterable
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 ByteList
from
- the start index (inclusive).to
- the end index (exclusive).public void addElements(int index, byte[] 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 ByteList
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, byte[] a)
addElements
in interface ByteList
index
- the index at which to add elements.a
- the array containing the elements.public void getElements(int from, byte[] 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 ByteList
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, byte[] a, int offset, int length)
ByteList
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 ByteList
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.Byte>
clear
in interface java.util.List<java.lang.Byte>
clear
in class java.util.AbstractCollection<java.lang.Byte>
removeElements(int, int)
.public int hashCode()
List.hashCode()
.hashCode
in interface java.util.Collection<java.lang.Byte>
hashCode
in interface java.util.List<java.lang.Byte>
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in interface java.util.Collection<java.lang.Byte>
equals
in interface java.util.List<java.lang.Byte>
equals
in class java.lang.Object
public int compareTo(java.util.List<? extends java.lang.Byte> 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.Byte>>
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(byte o)
ByteStack
push
in interface ByteStack
o
- the object to push on the stack.Stack.push(Object)
public byte popByte()
ByteStack
popByte
in interface ByteStack
Stack.pop()
public byte topByte()
ByteStack
topByte
in interface ByteStack
Stack.top()
public byte peekByte(int i)
ByteStack
peekByte
in interface ByteStack
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(byte k)
rem
in interface ByteCollection
rem
in class AbstractByteCollection
List.remove(Object)
indexOf()
.public byte[] toByteArray()
ByteCollection
toByteArray
in interface ByteCollection
toByteArray
in class AbstractByteCollection
Collection.toArray()
public byte[] toArray(byte[] a)
ByteCollection
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 ByteCollection
toArray
in class AbstractByteCollection
a
- if this array is big enough, it will be used to store this collection.Collection.toArray(Object[])
public boolean addAll(int index, ByteCollection c)
ByteList
public boolean addAll(ByteCollection c)
addAll
in interface ByteCollection
addAll
in class AbstractByteCollection
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 AbstractByteCollection