public class ByteArrayList extends AbstractByteList implements java.util.RandomAccess, java.lang.Cloneable, java.io.Serializable
This class implements a lightweight, fast, open, optimized,
reuse-oriented version of array-based lists. Instances of this class
represent a list with an array that is enlarged as needed when new entries
are created (by increasing its current length by 50%), but is
never made smaller (even on a clear()
). A family of
trimming methods lets you control the size of the
backing array; this is particularly useful if you reuse instances of this class.
Range checks are equivalent to those of java.util
's classes, but
they are delayed as much as possible. The backing array is exposed by the
elements()
method.
This class implements the bulk methods removeElements()
,
addElements()
and getElements()
using
high-performance system calls (e.g., System.arraycopy()
) instead of
expensive loops.
ArrayList
,
Serialized FormAbstractByteList.ByteRandomAccessSubList, AbstractByteList.ByteSubList
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_INITIAL_CAPACITY
The initial default capacity of an array list.
|
Constructor and Description |
---|
ByteArrayList()
Creates a new array list with
DEFAULT_INITIAL_CAPACITY capacity. |
ByteArrayList(byte[] a)
Creates a new array list and fills it with the elements of a given array.
|
ByteArrayList(byte[] a,
int offset,
int length)
Creates a new array list and fills it with the elements of a given array.
|
ByteArrayList(ByteCollection c)
Creates a new array list and fills it with a given type-specific collection.
|
ByteArrayList(ByteIterator i)
Creates a new array list and fills it with the elements returned by a type-specific iterator..
|
ByteArrayList(ByteList l)
Creates a new array list and fills it with a given type-specific list.
|
ByteArrayList(java.util.Collection<? extends java.lang.Byte> c)
Creates a new array list and fills it with a given collection.
|
ByteArrayList(int capacity)
Creates a new array list with given capacity.
|
ByteArrayList(java.util.Iterator<? extends java.lang.Byte> i)
Creates a new array list and fills it with the elements returned by an iterator..
|
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(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,
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,
int offset,
int length)
Adds elements to this type-specific list using optimized system calls.
|
void |
clear() |
ByteArrayList |
clone() |
int |
compareTo(ByteArrayList l)
Compares this array list to another array list.
|
int |
compareTo(java.util.List<? extends java.lang.Byte> l)
Compares this list to another object.
|
byte[] |
elements()
Returns the backing array of this list.
|
void |
ensureCapacity(int capacity)
Ensures that this array list can contain the given number of entries without resizing.
|
boolean |
equals(ByteArrayList l)
Compares this type-specific array list to another one.
|
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. |
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 element of this type-specific list into the given array using optimized system calls.
|
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.
|
boolean |
isEmpty()
Checks whether the stack is empty.
|
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(int index)
Returns a type-specific list iterator on the list starting at a given index.
|
static ByteArrayList |
of()
Creates a new empty array list.
|
static ByteArrayList |
of(byte... init)
Creates an array list using an array of elements.
|
boolean |
rem(byte k)
Removes a single instance of the specified element from this collection, if it is present (optional operation).
|
boolean |
removeAll(ByteCollection c)
Remove from this collection all elements in the given type-specific collection.
|
byte |
removeByte(int index)
Removes the element at the specified position in this list (optional operation).
|
void |
removeElements(int from,
int to)
Removes elements of this type-specific list using optimized system calls.
|
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)
Sets elements to this type-specific list using optimized system calls.
|
int |
size() |
void |
size(int size)
Sets the size of this list.
|
void |
sort(ByteComparator comp)
Sort a list using a type-specific comparator.
|
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. |
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.
|
void |
trim()
Trims this array list so that the capacity is equal to the size.
|
void |
trim(int n)
Trims the backing array if it is too large.
|
void |
unstableSort(ByteComparator comp)
Sorts this list using a sort not assured to be stable.
|
static ByteArrayList |
wrap(byte[] a)
Wraps a given array into an array list.
|
static ByteArrayList |
wrap(byte[] a,
int length)
Wraps a given array into an array list of given size.
|
addAll, addAll, addAll, addElements, contains, hashCode, iterator, listIterator, peekByte, popByte, push, toByteArray, topByte, toString
add, contains, containsAll, containsAll, remove, removeAll, retainAll, retainAll, toByteArray
add, add, addAll, contains, get, indexOf, lastIndexOf, of, of, of, remove, remove, replaceAll, replaceAll, replaceAll, set, setElements, setElements, sort, unstableSort
containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeIf, removeIf, removeIf, retainAll, stream, toByteArray
forEach, forEach
public static final int DEFAULT_INITIAL_CAPACITY
public ByteArrayList(int capacity)
capacity
- the initial capacity of the array list (may be 0).public ByteArrayList()
DEFAULT_INITIAL_CAPACITY
capacity.public ByteArrayList(java.util.Collection<? extends java.lang.Byte> c)
c
- a collection that will be used to fill the array list.public ByteArrayList(ByteCollection c)
c
- a type-specific collection that will be used to fill the array list.public ByteArrayList(ByteList l)
l
- a type-specific list that will be used to fill the array list.public ByteArrayList(byte[] a)
a
- an array whose elements will be used to fill the array list.public ByteArrayList(byte[] a, int offset, int length)
a
- an array whose elements will be used to fill the array list.offset
- the first element to use.length
- the number of elements to use.public ByteArrayList(java.util.Iterator<? extends java.lang.Byte> i)
i
- an iterator whose returned elements will fill the array list.public ByteArrayList(ByteIterator i)
i
- a type-specific iterator whose returned elements will fill the array list.public byte[] elements()
public static ByteArrayList wrap(byte[] a, int length)
Note it is guaranteed
that the type of the array returned by elements()
will be the same
(see the comments in the class documentation).
a
- an array to wrap.length
- the length of the resulting array list.public static ByteArrayList wrap(byte[] a)
Note it is guaranteed
that the type of the array returned by elements()
will be the same
(see the comments in the class documentation).
a
- an array to wrap.public static ByteArrayList of()
public static ByteArrayList of(byte... init)
of
in interface ByteList
init
- a the array the will become the new backing array of the array list.wrap(byte[], int)
public void ensureCapacity(int capacity)
capacity
- the new minimum capacity for this array list.public void add(int index, byte k)
AbstractByteList
add
in interface ByteList
add
in class AbstractByteList
List.add(int,Object)
public boolean add(byte k)
AbstractByteList
add
in interface ByteCollection
add
in interface ByteList
add
in class AbstractByteList
Collection.add(Object)
public byte getByte(int index)
ByteList
public int indexOf(byte k)
ByteList
indexOf
in interface ByteList
indexOf
in class AbstractByteList
List.indexOf(Object)
public int lastIndexOf(byte k)
ByteList
lastIndexOf
in interface ByteList
lastIndexOf
in class AbstractByteList
List.lastIndexOf(Object)
public byte removeByte(int index)
AbstractByteList
removeByte
in interface ByteList
removeByte
in class AbstractByteList
List.remove(int)
public boolean rem(byte k)
AbstractByteList
rem
in interface ByteCollection
rem
in class AbstractByteList
List.remove(Object)
public byte set(int index, byte k)
AbstractByteList
set
in interface ByteList
set
in class AbstractByteList
List.set(int,Object)
public void clear()
AbstractByteList
clear
in interface java.util.Collection<java.lang.Byte>
clear
in interface java.util.List<java.lang.Byte>
clear
in class AbstractByteList
public int size()
size
in interface java.util.Collection<java.lang.Byte>
size
in interface java.util.List<java.lang.Byte>
size
in class java.util.AbstractCollection<java.lang.Byte>
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
.
size
in interface ByteList
size
in class AbstractByteList
size
- the new size.public boolean isEmpty()
Stack
isEmpty
in interface Stack<java.lang.Byte>
isEmpty
in interface java.util.Collection<java.lang.Byte>
isEmpty
in interface java.util.List<java.lang.Byte>
isEmpty
in class java.util.AbstractCollection<java.lang.Byte>
public void trim()
ArrayList.trimToSize()
public void trim(int n)
n
, this method does nothing. Otherwise, it trims the
array length to the maximum between n
and size()
.
This method is useful when reusing lists. Clearing a list leaves the array length untouched. If you are reusing a list many times, you can call this method with a typical size to avoid keeping around a very large array just because of a few large transient lists.
n
- the threshold for the trimming.public ByteList subList(int from, int to)
ByteList
from
, inclusive, to the index to
, exclusive.subList
in interface ByteList
subList
in interface java.util.List<java.lang.Byte>
subList
in class AbstractByteList
List.subList(int,int)
public void getElements(int from, byte[] a, int offset, int length)
getElements
in interface ByteList
getElements
in class AbstractByteList
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 removeElements(int from, int to)
removeElements
in interface ByteList
removeElements
in class AbstractByteList
from
- the start index (inclusive).to
- the end index (exclusive).public void addElements(int index, byte[] a, int offset, int length)
addElements
in interface ByteList
addElements
in class AbstractByteList
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 setElements(int index, byte[] a, int offset, int length)
setElements
in interface ByteList
setElements
in class AbstractByteList
index
- the index at which to start setting 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 forEach(ByteConsumer action)
AbstractByteList
Iterable
until all elements have been processed or the action throws an
exception.forEach
in interface ByteIterable
forEach
in class AbstractByteList
action
- the action to be performed for each element.Iterable.forEach(java.util.function.Consumer)
public boolean addAll(int index, ByteCollection c)
ByteList
addAll
in interface ByteList
addAll
in class AbstractByteList
List.addAll(int,java.util.Collection)
public boolean addAll(int index, ByteList l)
ByteList
public boolean removeAll(ByteCollection c)
ByteCollection
removeAll
in interface ByteCollection
removeAll
in class AbstractByteCollection
c
- a type-specific collection.true
if this collection changed as a result of the call.Collection.removeAll(Collection)
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 AbstractByteList
a
- if this array is big enough, it will be used to store this collection.Collection.toArray(Object[])
public ByteListIterator listIterator(int index)
AbstractByteList
listIterator
in interface ByteList
listIterator
in interface java.util.List<java.lang.Byte>
listIterator
in class AbstractByteList
List.listIterator(int)
public 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.
The returned spliterator is late-binding; it will track structural changes
after the current index, up until the first trySplit()
,
at which point the maximum index will be fixed.
Structural changes before the current index or after the first
trySplit()
will result in unspecified behavior.
spliterator
in interface ByteCollection
spliterator
in interface ByteIterable
spliterator
in interface ByteList
spliterator
in interface java.lang.Iterable<java.lang.Byte>
spliterator
in interface java.util.Collection<java.lang.Byte>
spliterator
in interface java.util.List<java.lang.Byte>
public void sort(ByteComparator comp)
ByteList
Pass null
to sort using natural ordering.
public void unstableSort(ByteComparator comp)
ByteList
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.
unstableSort
in interface ByteList
public ByteArrayList clone()
clone
in class java.lang.Object
public boolean equals(ByteArrayList l)
l
- a type-specific array list.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 AbstractByteList
public int compareTo(ByteArrayList l)
l
- an array list.public int compareTo(java.util.List<? extends java.lang.Byte> l)
AbstractByteList
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>>
compareTo
in class AbstractByteList
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.