public interface ByteList extends java.util.List<java.lang.Byte>, java.lang.Comparable<java.util.List<? extends java.lang.Byte>>, ByteCollection
List
; 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 usual compareTo()
method for objects.
Additionally, this interface strengthens iterator()
, listIterator()
,
listIterator(int)
and subList(int,int)
. The former had been already
strengthened upstream, but unfortunately List
re-specifies it.
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.
List
Modifier and Type | Method and Description |
---|---|
boolean |
add(byte key)
Appends the specified element to the end of this list (optional operation).
|
default boolean |
add(java.lang.Byte k)
Deprecated.
Please use the corresponding type-specific method instead.
|
void |
add(int index,
byte key)
Inserts the specified element at the specified position in this list (optional operation).
|
default void |
add(int index,
java.lang.Byte key)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
addAll(ByteList l)
Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).
|
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).
|
default boolean |
addAll(int index,
ByteList l)
Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (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.
|
default boolean |
contains(java.lang.Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
default java.lang.Byte |
get(int index)
Deprecated.
Please use the corresponding type-specific method instead.
|
byte |
getByte(int index)
Returns the element at the specified position in this list.
|
void |
getElements(int from,
byte[] a,
int offset,
int length)
Copies (hopefully quickly) elements of this type-specific list into the given array.
|
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.
|
default int |
indexOf(java.lang.Object o)
Deprecated.
Please use the corresponding type-specific method instead.
|
ByteListIterator |
iterator()
Returns a type-specific iterator on the elements of this list.
|
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.
|
default int |
lastIndexOf(java.lang.Object o)
Deprecated.
Please use the corresponding type-specific method instead.
|
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.
|
static ByteList |
of()
Returns an immutable empty list.
|
static ByteList |
of(byte... a)
Returns an immutable list with the elements given.
|
static ByteList |
of(byte e)
Returns an immutable list with the element given.
|
static ByteList |
of(byte e0,
byte e1)
Returns an immutable list with the elements given.
|
static ByteList |
of(byte e0,
byte e1,
byte e2)
Returns an immutable list with the elements given.
|
default java.lang.Byte |
remove(int index)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
remove(java.lang.Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
byte |
removeByte(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.
|
default void |
replaceAll(ByteUnaryOperator operator)
Replaces each element of this list with the result of applying the
operator to that element.
|
default void |
replaceAll(java.util.function.IntUnaryOperator operator)
Replaces each element of this list with the result of applying the
operator to that element, performing widening and narrowing primitive casts,
until all elements have been processed or the action
throws an exception.
|
default void |
replaceAll(java.util.function.UnaryOperator<java.lang.Byte> operator)
Deprecated.
Please use the corresponding type-specific method instead.
|
byte |
set(int index,
byte k)
Replaces the element at the specified position in this list with the specified element (optional operation).
|
default java.lang.Byte |
set(int index,
java.lang.Byte k)
Deprecated.
Please use the corresponding type-specific method instead.
|
default void |
setElements(byte[] a)
Set (hopefully quickly) elements to match the array given.
|
default void |
setElements(int index,
byte[] a)
Set (hopefully quickly) elements to match the array given.
|
default 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.
|
default void |
sort(ByteComparator comparator)
Sort a list using a type-specific comparator.
|
default void |
sort(java.util.Comparator<? super java.lang.Byte> comparator)
Deprecated.
Please use the corresponding type-specific method instead.
|
default ByteSpliterator |
spliterator()
Returns a type-specific spliterator on the elements 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. |
default void |
unstableSort(ByteComparator comparator)
Sorts this list using a sort not assured to be stable.
|
default void |
unstableSort(java.util.Comparator<? super java.lang.Byte> comparator)
Deprecated.
Please use the corresponding type-specific method instead.
|
addAll, addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, size, toArray, toArray
addAll, contains, containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, rem, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toArray, toByteArray, toByteArray
forEach, forEach, forEach
ByteListIterator iterator()
iterator
in interface ByteCollection
iterator
in interface ByteIterable
iterator
in interface java.util.Collection<java.lang.Byte>
iterator
in interface java.lang.Iterable<java.lang.Byte>
iterator
in interface java.util.List<java.lang.Byte>
Iterable.iterator()
List.iterator()
.
It would not be normally necessary, but Iterable.iterator()
is bizarrily re-specified
in List
.
Also, this is generally the only iterator
method subclasses should override.
default ByteSpliterator spliterator()
List spliterators must report at least Spliterator.SIZED
and Spliterator.ORDERED
.
See List.spliterator()
for more documentation on the requirements
of the returned spliterator.
spliterator
in interface ByteCollection
spliterator
in interface ByteIterable
spliterator
in interface java.util.Collection<java.lang.Byte>
spliterator
in interface java.lang.Iterable<java.lang.Byte>
spliterator
in interface java.util.List<java.lang.Byte>
Collection.spliterator()
, which was already
strengthened in the corresponding type-specific class,
but was weakened by the fact that this interface extends List
.
Also, this is generally the only spliterator
method subclasses should override.
Spliterator
for documentation on what binding policies mean).
RandomAccess
lists, this will return a spliterator
that calls the type-specific get(int)
method on the appropriate indexes.iterator()
.In either case, the spliterator reports Spliterator.SIZED
,
Spliterator.SUBSIZED
, and Spliterator.ORDERED
.
Iterator
is an inherently linear API, the returned
spliterator will yield limited performance gains when run in parallel contexts, as the
returned spliterator's trySplit()
will have linear runtime.
For RandomAccess
lists, the parallel performance should
be reasonable assuming get(int)
is truly constant time like RandomAccess
suggests.
ByteListIterator listIterator()
listIterator
in interface java.util.List<java.lang.Byte>
List.listIterator()
ByteListIterator listIterator(int index)
listIterator
in interface java.util.List<java.lang.Byte>
List.listIterator(int)
ByteList subList(int from, int to)
from
, inclusive, to the index to
, exclusive.subList
in interface java.util.List<java.lang.Byte>
List.subList(int,int)
List.subList(int,int)
.void size(int size)
If the specified size is smaller than the current size, the last elements are
discarded. Otherwise, they are filled with 0/null
/false
.
size
- the new size.void getElements(int from, byte[] a, int offset, int length)
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.void removeElements(int from, int to)
from
- the start index (inclusive).to
- the end index (exclusive).void addElements(int index, byte[] a)
index
- the index at which to add elements.a
- the array containing the elements.void addElements(int index, byte[] a, int offset, int length)
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.default void setElements(byte[] a)
a
- the array containing the elements.default void setElements(int index, byte[] a)
index
- the index at which to start setting elements.a
- the array containing the elements.default void setElements(int index, byte[] a, int offset, int length)
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.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.boolean add(byte key)
add
in interface ByteCollection
List.add(Object)
void add(int index, byte key)
List.add(int,Object)
@Deprecated default void add(int index, java.lang.Byte key)
add
in interface java.util.List<java.lang.Byte>
boolean addAll(int index, ByteCollection c)
List.addAll(int,java.util.Collection)
byte set(int index, byte k)
List.set(int,Object)
default void replaceAll(ByteUnaryOperator operator)
operator
- the operator to apply to each element.List.replaceAll(java.util.function.UnaryOperator<E>)
default void replaceAll(java.util.function.IntUnaryOperator operator)
operator
- the operator to apply to each elementList.replaceAll(java.util.function.UnaryOperator<E>)
@Deprecated default void replaceAll(java.util.function.UnaryOperator<java.lang.Byte> operator)
replaceAll
in interface java.util.List<java.lang.Byte>
byte getByte(int index)
List.get(int)
int indexOf(byte k)
List.indexOf(Object)
int lastIndexOf(byte k)
List.lastIndexOf(Object)
@Deprecated default boolean contains(java.lang.Object key)
contains
in interface ByteCollection
contains
in interface java.util.Collection<java.lang.Byte>
contains
in interface java.util.List<java.lang.Byte>
@Deprecated default java.lang.Byte get(int index)
get
in interface java.util.List<java.lang.Byte>
@Deprecated default int indexOf(java.lang.Object o)
indexOf
in interface java.util.List<java.lang.Byte>
@Deprecated default int lastIndexOf(java.lang.Object o)
lastIndexOf
in interface java.util.List<java.lang.Byte>
@Deprecated default boolean add(java.lang.Byte k)
This method specification is a workaround for bug 8177440.
add
in interface ByteCollection
add
in interface java.util.Collection<java.lang.Byte>
add
in interface java.util.List<java.lang.Byte>
byte removeByte(int index)
List.remove(int)
@Deprecated default boolean remove(java.lang.Object key)
remove
in interface ByteCollection
remove
in interface java.util.Collection<java.lang.Byte>
remove
in interface java.util.List<java.lang.Byte>
@Deprecated default java.lang.Byte remove(int index)
remove
in interface java.util.List<java.lang.Byte>
@Deprecated default java.lang.Byte set(int index, java.lang.Byte k)
set
in interface java.util.List<java.lang.Byte>
default boolean addAll(int index, ByteList l)
List.addAll(int,Collection)
getElements(int, byte[], int, int)
/addElements(int, byte[])
.default boolean addAll(ByteList l)
List.addAll(Collection)
List.size()
as first argument.static ByteList of()
static ByteList of(byte e)
e
- the element that the returned list will contain.e
.static ByteList of(byte e0, byte e1)
e0
- the first element.e1
- the second element.e0
and e1
.static ByteList of(byte e0, byte e1, byte e2)
e0
- the first element.e1
- the second element.e2
- the third element.e0
, e1
, and e2
.static ByteList of(byte... a)
Note that this method does not perform a defensive copy.
a
- a list of elements that will be used to initialize the immutable list.a
.@Deprecated default void sort(java.util.Comparator<? super java.lang.Byte> comparator)
sort
in interface java.util.List<java.lang.Byte>
default void sort(ByteComparator comparator)
Pass null
to sort using natural ordering.
List.sort(java.util.Comparator)
List.toArray()
, sorts the array, then replaces all elements using the
setElements(byte[])
function.
It is possible for this method to call unstableSort(java.util.Comparator<? super java.lang.Byte>)
if it can
determine that the results of a stable and unstable sort are completely equivalent.
This means if you override unstableSort(java.util.Comparator<? super java.lang.Byte>)
, it should not call this
method unless you override this method as well.
@Deprecated default void unstableSort(java.util.Comparator<? super java.lang.Byte> comparator)
default void unstableSort(ByteComparator comparator)
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.
List.toArray()
, sorts the array, then replaces all elements using the
setElements(byte[])
function.