public class ReferenceBigArrayBigList<K> extends AbstractReferenceBigList<K> implements java.util.RandomAccess, java.lang.Cloneable, java.io.Serializable
This class implements a lightweight, fast, open, optimized,
reuse-oriented version of big-array-based big lists. Instances of this class
represent a big list with a big array that is enlarged as needed when new entries
are created (by increasing its current length to 50%), but is
never made smaller (even on a clear()
). A family of
trimming methods lets you control the size of the
backing big 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 big array is exposed by the elements()
method. If an instance
of this class was created by wrapping,
backing-array reallocations will be performed using reflection, so that
elements()
can return a big array of the same type of the original big array; the comments
about efficiency made in ObjectArrays
apply here.
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 FormAbstractReferenceBigList.ReferenceRandomAccessSubList<K>, AbstractReferenceBigList.ReferenceSubList<K>
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_INITIAL_CAPACITY
The initial default capacity of a big-array big list.
|
Constructor and Description |
---|
ReferenceBigArrayBigList()
Creates a new big-array big list with
DEFAULT_INITIAL_CAPACITY capacity. |
ReferenceBigArrayBigList(java.util.Collection<? extends K> c)
Creates a new big-array big list and fills it with a given collection.
|
ReferenceBigArrayBigList(java.util.Iterator<? extends K> i)
Creates a new big-array big list and fills it with the elements returned by an iterator..
|
ReferenceBigArrayBigList(K[][] a)
Creates a new big-array big list and fills it with the elements of a given big array.
|
ReferenceBigArrayBigList(K[][] a,
long offset,
long length)
Creates a new big-array big list and fills it with the elements of a given big array.
|
ReferenceBigArrayBigList(long capacity)
Creates a new big-array big list with given capacity.
|
ReferenceBigArrayBigList(ObjectIterator<? extends K> i)
Creates a new big-array big list and fills it with the elements returned by a type-specific iterator..
|
ReferenceBigArrayBigList(ReferenceBigList<? extends K> l)
Creates a new big-array big list and fills it with a given type-specific list.
|
ReferenceBigArrayBigList(ReferenceCollection<? extends K> c)
Creates a new big-array big list and fills it with a given type-specific collection.
|
Modifier and Type | Method and Description |
---|---|
boolean |
add(K k) |
void |
add(long index,
K k)
Inserts the specified element at the specified position in this big list (optional operation).
|
boolean |
addAll(long index,
java.util.Collection<? extends K> c)
Adds all of the elements in the specified collection to this list (optional operation).
|
boolean |
addAll(long index,
ReferenceBigList<? extends K> list)
Inserts all of the elements in the specified type-specific big list into this type-specific big list at the specified position (optional operation).
|
boolean |
addAll(long index,
ReferenceList<? extends K> list)
Inserts all of the elements in the specified type-specific list into this type-specific big list at the specified position (optional operation).
|
void |
addElements(long index,
K[][] a,
long offset,
long length)
Adds elements to this type-specific list using optimized system calls.
|
void |
clear() |
ReferenceBigArrayBigList<K> |
clone() |
K[][] |
elements()
Returns the backing big array of this big list.
|
void |
ensureCapacity(long capacity)
Ensures that this big-array big list can contain the given number of entries without resizing.
|
boolean |
equals(java.lang.Object o) |
boolean |
equals(ReferenceBigArrayBigList<K> l)
Compares this type-specific big-array list to another one.
|
void |
forEach(java.util.function.Consumer<? super K> action) |
K |
get(long index)
Returns the element at the specified position.
|
void |
getElements(long from,
java.lang.Object[][] a,
long offset,
long length)
Copies element of this type-specific list into the given big array using optimized system calls.
|
long |
indexOf(java.lang.Object k)
Returns the index of the first occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
|
boolean |
isEmpty()
Checks whether the stack is empty.
|
long |
lastIndexOf(java.lang.Object k)
Returns the index of the last occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
|
ObjectBigListIterator<K> |
listIterator(long index)
Returns a type-specific list iterator on this type-specific big list starting at a given index.
|
static <K> ReferenceBigArrayBigList<K> |
of()
Creates a new empty big array list.
|
static <K> ReferenceBigArrayBigList<K> |
of(K... init)
Creates a big array list using a list of elements.
|
K |
remove(long index)
Removes the element at the specified position.
|
boolean |
remove(java.lang.Object k) |
boolean |
removeAll(java.util.Collection<?> c) |
void |
removeElements(long from,
long to)
Removes elements of this type-specific list using optimized system calls.
|
K |
set(long index,
K k)
Replaces the element at the specified position in this big list with the specified element (optional operation).
|
void |
setElements(long index,
java.lang.Object[][] a,
long offset,
long length)
Copies elements in the given big array into this type-specific list using optimized system calls.
|
void |
size(long size)
Sets the size of this big list.
|
long |
size64()
Returns the size of this data structure as a long.
|
ObjectSpliterator<K> |
spliterator()
Returns a type-specific spliterator on the elements of this big-list.
|
ReferenceBigList<K> |
subList(long from,
long to)
Returns a type-specific view of the portion of this type-specific big list from the index
from , inclusive, to the index to , exclusive. |
static <K> java.util.stream.Collector<K,?,ReferenceBigArrayBigList<K>> |
toBigList()
Returns a
Collector that collects a Stream 's elements into a new ArrayList. |
static <K> java.util.stream.Collector<K,?,ReferenceBigArrayBigList<K>> |
toBigListWithExpectedSize(long expectedSize)
Returns a
Collector that collects a Stream 's elements into a new ArrayList. |
void |
trim()
Trims this big-array big list so that the capacity is equal to the size.
|
void |
trim(long n)
Trims the backing big array if it is too large.
|
static <K> ReferenceBigArrayBigList<K> |
wrap(K[][] a)
Wraps a given big array into a big-array big list.
|
static <K> ReferenceBigArrayBigList<K> |
wrap(K[][] a,
long length)
Wraps a given big array into a big-array list of given size.
|
addAll, addElements, contains, hashCode, iterator, listIterator, peek, pop, push, size, top, toString
addAll, addAll, setElements, setElements
public static final int DEFAULT_INITIAL_CAPACITY
public ReferenceBigArrayBigList(long capacity)
capacity
- the initial capacity of the array list (may be 0).public ReferenceBigArrayBigList()
DEFAULT_INITIAL_CAPACITY
capacity.public ReferenceBigArrayBigList(ReferenceCollection<? extends K> c)
c
- a type-specific collection that will be used to fill the array list.public ReferenceBigArrayBigList(java.util.Collection<? extends K> c)
c
- a collection that will be used to fill the array list.public ReferenceBigArrayBigList(ReferenceBigList<? extends K> l)
l
- a type-specific list that will be used to fill the array list.public ReferenceBigArrayBigList(K[][] a)
a
- a big array whose elements will be used to fill the array list.public ReferenceBigArrayBigList(K[][] a, long offset, long length)
a
- a big 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 ReferenceBigArrayBigList(java.util.Iterator<? extends K> i)
i
- an iterator whose returned elements will fill the array list.public ReferenceBigArrayBigList(ObjectIterator<? extends K> i)
i
- a type-specific iterator whose returned elements will fill the array list.public K[][] elements()
If this big-array big list was created by wrapping a given big array, it is guaranteed that the type of the returned big array will be the same. Otherwise, the returned big array will be an big array of objects.
public static <K> ReferenceBigArrayBigList<K> wrap(K[][] a, long length)
a
- a big array to wrap.length
- the length of the resulting big-array list.public static <K> ReferenceBigArrayBigList<K> wrap(K[][] a)
a
- a big array to wrap.public static <K> ReferenceBigArrayBigList<K> of()
@SafeVarargs public static <K> ReferenceBigArrayBigList<K> of(K... init)
init
- a list of elements that will be used to initialize the big list.
It is possible (but not assured) that the returned big-array big list will be
backed by the given array in one of its segments.BigArrays.wrap(byte[])
public static <K> java.util.stream.Collector<K,?,ReferenceBigArrayBigList<K>> toBigList()
Collector
that collects a Stream
's elements into a new ArrayList.public static <K> java.util.stream.Collector<K,?,ReferenceBigArrayBigList<K>> toBigListWithExpectedSize(long expectedSize)
Collector
that collects a Stream
's elements into a new ArrayList.public void ensureCapacity(long capacity)
capacity
- the new minimum capacity for this big-array big list.public void add(long index, K k)
AbstractReferenceBigList
public boolean add(K k)
AbstractReferenceBigList
add
in interface java.util.Collection<K>
add
in class AbstractReferenceBigList<K>
public K get(long index)
BigList
public long indexOf(java.lang.Object k)
BigList
indexOf
in interface BigList<K>
indexOf
in class AbstractReferenceBigList<K>
k
- the object to search for.List.indexOf(Object)
public long lastIndexOf(java.lang.Object k)
BigList
lastIndexOf
in interface BigList<K>
lastIndexOf
in class AbstractReferenceBigList<K>
k
- the object to search for.List.lastIndexOf(Object)
public K remove(long index)
AbstractReferenceBigList
public boolean remove(java.lang.Object k)
public K set(long index, K k)
AbstractReferenceBigList
public boolean removeAll(java.util.Collection<?> c)
public boolean addAll(long index, java.util.Collection<? extends K> c)
AbstractReferenceBigList
addAll
in interface BigList<K>
addAll
in class AbstractReferenceBigList<K>
index
- index at which to insert the first element from the specified collection.c
- collection containing elements to be added to this big list.true
if this big list changed as a result of the callList.addAll(int, Collection)
public boolean addAll(long index, ReferenceBigList<? extends K> list)
ReferenceBigList
addAll
in interface ReferenceBigList<K>
BigList.addAll(long,Collection)
public boolean addAll(long index, ReferenceList<? extends K> list)
ReferenceBigList
addAll
in interface ReferenceBigList<K>
BigList.addAll(long,Collection)
public void clear()
AbstractReferenceBigList
clear
in interface java.util.Collection<K>
clear
in class AbstractReferenceBigList<K>
public long size64()
Size64
public void size(long size)
BigList
If the specified size is smaller than the current size, the last elements are
discarded. Otherwise, they are filled with 0/null
/false
.
public boolean isEmpty()
Stack
public void trim()
ArrayList.trimToSize()
public void trim(long n)
n
, this method does nothing. Otherwise, it trims the
big-array length to the maximum between n
and size64()
.
This method is useful when reusing big lists. Clearing a big list leaves the big-array length untouched. If you are reusing a big list many times, you can call this method with a typical size to avoid keeping around a very large big array just because of a few large transient big lists.
n
- the threshold for the trimming.public ReferenceBigList<K> subList(long from, long to)
ReferenceBigList
from
, inclusive, to the index to
, exclusive.subList
in interface BigList<K>
subList
in interface ReferenceBigList<K>
subList
in class AbstractReferenceBigList<K>
from
- the starting element (inclusive).to
- the ending element (exclusive).BigList.subList(long,long)
public void getElements(long from, java.lang.Object[][] a, long offset, long length)
getElements
in interface ReferenceBigList<K>
getElements
in class AbstractReferenceBigList<K>
from
- the start index (inclusive).a
- the destination big 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(long from, long to)
removeElements
in interface ReferenceBigList<K>
removeElements
in class AbstractReferenceBigList<K>
from
- the start index (inclusive).to
- the end index (exclusive).public void addElements(long index, K[][] a, long offset, long length)
addElements
in interface ReferenceBigList<K>
addElements
in class AbstractReferenceBigList<K>
index
- the index at which to add elements.a
- the big array containing the elements.offset
- the offset of the first element to add.length
- the number of elements to add.public void setElements(long index, java.lang.Object[][] a, long offset, long length)
setElements
in interface ReferenceBigList<K>
setElements
in class AbstractReferenceBigList<K>
index
- the start index (inclusive).a
- the destination big 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 forEach(java.util.function.Consumer<? super K> action)
AbstractReferenceBigList
forEach
in interface java.lang.Iterable<K>
forEach
in class AbstractReferenceBigList<K>
public ObjectBigListIterator<K> listIterator(long index)
AbstractReferenceBigList
listIterator
in interface BigList<K>
listIterator
in interface ReferenceBigList<K>
listIterator
in class AbstractReferenceBigList<K>
index
- index of first element to be returned from the big-list iterator.BigList.listIterator(long)
public ObjectSpliterator<K> spliterator()
ReferenceBigList
BigList spliterators must report at least Spliterator.SIZED
and Spliterator.ORDERED
.
See List.spliterator()
for more documentation on the requirements
of the returned spliterator (despite BigList
not being a List
, most of the
same requirements apply.
spliterator
in interface ObjectIterable<K>
spliterator
in interface ReferenceBigList<K>
spliterator
in interface ReferenceCollection<K>
spliterator
in interface java.lang.Iterable<K>
spliterator
in interface java.util.Collection<K>
public ReferenceBigArrayBigList<K> clone()
clone
in class java.lang.Object
public boolean equals(ReferenceBigArrayBigList<K> l)
This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
l
- a type-specific big-array list.public boolean equals(java.lang.Object o)
equals
in interface java.util.Collection<K>
equals
in class AbstractReferenceBigList<K>