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 doubling its current length), 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.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) |
void |
add(int index,
byte k) |
boolean |
addAll(int index,
ByteCollection c)
Delegates to a more generic method.
|
boolean |
addAll(int index,
ByteList l)
Delegates to a more generic method.
|
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.
|
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.
|
byte |
getByte(int index) |
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) |
boolean |
isEmpty()
Checks whether the stack is empty.
|
int |
lastIndexOf(byte k) |
ByteListIterator |
listIterator(int index)
Returns a type-specific list iterator on the list starting at a given index.
|
boolean |
rem(byte k)
Note that this method should be called
remove() , but the clash
with the similarly named index-based method in the List interface
forces us to use a distinguished name. |
byte |
removeByte(int index) |
void |
removeElements(int from,
int to)
Removes elements of this type-specific list using optimized system calls.
|
byte |
set(int index,
byte k) |
int |
size() |
void |
size(int size)
Sets the size of this list.
|
byte[] |
toByteArray(byte[] a)
Returns a primitive type array containing the items of this collection.
|
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.
|
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.
|
add, addAll, addAll, addAll, addAll, addElements, byteListIterator, byteListIterator, byteSubList, compareTo, contains, equals, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, peek, peekByte, pop, popByte, push, push, remove, remove, set, subList, top, topByte, toString
add, byteIterator, contains, containsAll, containsAll, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toByteArray
add, contains, containsAll, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray
byteIterator, containsAll, removeAll, retainAll, toArray, toArray, toByteArray
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)
a
- an array to wrap.length
- the length of the resulting array list.public static ByteArrayList wrap(byte[] a)
a
- an array to wrap.public void ensureCapacity(int capacity)
capacity
- the new minimum capacity for this array list.public void add(int index, byte k)
add
in interface ByteList
add
in class AbstractByteList
List.add(int,Object)
public boolean add(byte k)
add
in interface ByteCollection
add
in interface ByteList
add
in class AbstractByteList
Collection.add(Object)
public byte getByte(int index)
public int indexOf(byte k)
indexOf
in interface ByteList
indexOf
in class AbstractByteList
List.indexOf(Object)
public int lastIndexOf(byte k)
lastIndexOf
in interface ByteList
lastIndexOf
in class AbstractByteList
List.lastIndexOf(Object)
public byte removeByte(int index)
removeByte
in interface ByteList
removeByte
in class AbstractByteList
List.remove(int)
public boolean rem(byte k)
ByteCollection
remove()
, but the clash
with the similarly named index-based method in the List
interface
forces us to use a distinguished name. For simplicity, the set interfaces reinstates
remove()
.rem
in interface ByteCollection
rem
in class AbstractByteList
Collection.remove(Object)
public byte set(int index, byte k)
set
in interface ByteList
set
in class AbstractByteList
List.set(int,Object)
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>
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 AbstractByteCollection
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 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 byte[] toByteArray(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.
toByteArray
in interface ByteCollection
toByteArray
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)
AbstractByteList
addAll
in interface ByteList
addAll
in class AbstractByteList
List.add(int,Object)
public boolean addAll(int index, ByteList l)
AbstractByteList
addAll
in interface ByteList
addAll
in class AbstractByteList
List.add(int,Object)
public ByteListIterator listIterator(int index)
ByteList
listIterator
in interface ByteList
listIterator
in interface java.util.List<java.lang.Byte>
listIterator
in class AbstractByteList
List.listIterator(int)
public ByteArrayList clone()
clone
in class java.lang.Object
public boolean equals(ByteArrayList l)
This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
l
- a type-specific array list.public int compareTo(ByteArrayList l)
This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
l
- an array list.