public class ObjectBigArrayBigList<K> extends AbstractObjectBigList<K> implements RandomAccess, Cloneable, 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 doubling the current length), 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 FormAbstractObjectBigList.ObjectSubList<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 |
|---|
ObjectBigArrayBigList()
Creates a new big-array big list with
DEFAULT_INITIAL_CAPACITY
capacity. |
ObjectBigArrayBigList(Iterator<? extends K> i)
Creates a new big-array big list and fills it with the elements returned
by an iterator..
|
ObjectBigArrayBigList(K[][] a)
Creates a new big-array big list and fills it with the elements of a
given big array.
|
ObjectBigArrayBigList(K[][] a,
long offset,
long length)
Creates a new big-array big list and fills it with the elements of a
given big array.
|
ObjectBigArrayBigList(long capacity)
Creates a new big-array big list with given capacity.
|
ObjectBigArrayBigList(ObjectBigList<? extends K> l)
Creates a new big-array big list and fills it with a given type-specific
list.
|
ObjectBigArrayBigList(ObjectCollection<? extends K> c)
Creates a new big-array big list and fills it with a given type-specific
collection.
|
ObjectBigArrayBigList(ObjectIterator<? extends K> i)
Creates a new big-array big list and fills it with the elements returned
by a type-specific iterator..
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
add(K k)
Ensures that this collection contains the specified element (optional
operation).
|
void |
add(long index,
K k)
Inserts the specified element at the specified position in this big list (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()
Removes all of the elements from this collection (optional operation).
|
ObjectBigArrayBigList<K> |
clone()
Creates and returns a copy of this object.
|
int |
compareTo(ObjectBigArrayBigList<? extends K> l)
Compares this big list to another big list.
|
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(ObjectBigArrayBigList<K> l)
Compares this type-specific big-array list to another one.
|
K |
get(long index)
Returns the element at the specified position.
|
void |
getElements(long from,
Object[][] a,
long offset,
long length)
Copies element of this type-specific list into the given big array using
optimized system calls.
|
long |
indexOf(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()
Returns true if this collection contains no elements.
|
long |
lastIndexOf(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.
|
K |
remove(long index)
Removes the element at the specified position.
|
boolean |
remove(Object k)
Removes a single instance of the specified element from this
collection, if it is present (optional operation).
|
boolean |
removeAll(Collection<?> c)
Removes all of this collection's elements that are also contained in the
specified collection (optional operation).
|
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 |
size(long size)
Sets the size of this big list.
|
long |
size64()
Returns the size of this data structure as a long.
|
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> ObjectBigArrayBigList<K> |
wrap(K[][] a)
Wraps a given big array into a big-array big list.
|
static <K> ObjectBigArrayBigList<K> |
wrap(K[][] a,
long length)
Wraps a given big array into a big-array list of given size.
|
addAll, addAll, addElements, compareTo, contains, equals, hashCode, iterator, listIterator, peek, pop, push, size, subList, top, toStringcontainsAll, retainAll, toArray, toArraycontainsAll, parallelStream, removeIf, retainAll, spliterator, stream, toArray, toArraypublic static final int DEFAULT_INITIAL_CAPACITY
public ObjectBigArrayBigList(long capacity)
capacity - the initial capacity of the array list (may be 0).public ObjectBigArrayBigList()
DEFAULT_INITIAL_CAPACITY
capacity.public ObjectBigArrayBigList(ObjectCollection<? extends K> c)
c - a type-specific collection that will be used to fill the array
list.public ObjectBigArrayBigList(ObjectBigList<? extends K> l)
l - a type-specific list that will be used to fill the array list.public ObjectBigArrayBigList(K[][] a)
Note that this constructor makes it easy to build big lists from literal
arrays declared as
type[][] {{ init_values }}. The only
constraint is that the number of initialisation values is below
BigArrays.SEGMENT_SIZE.
a - a big array whose elements will be used to fill the array
list.public ObjectBigArrayBigList(K[][] a, long offset, long length)
Note that this constructor makes it easy to build big lists from literal
arrays declared as
type[][] {{ init_values }}. The only
constraint is that the number of initialisation values is below
BigArrays.SEGMENT_SIZE.
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 ObjectBigArrayBigList(Iterator<? extends K> i)
i - an iterator whose returned elements will fill the array list.public ObjectBigArrayBigList(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> ObjectBigArrayBigList<K> wrap(K[][] a, long length)
a - a big array to wrap.length - the length of the resulting big-array list.public static <K> ObjectBigArrayBigList<K> wrap(K[][] a)
a - a big array to wrap.public void ensureCapacity(long capacity)
capacity - the new minimum capacity for this big-array big list.public void add(long index,
K k)
AbstractObjectBigList
This implementation always throws an
UnsupportedOperationException.
add in interface BigList<K>add in class AbstractObjectBigList<K>index - a position in the big list.k - an element to be inserted.List.add(int,Object)public boolean add(K k)
AbstractObjectBigListCollections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.
If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.
This implementation always throws an UnsupportedOperationException.
This implementation delegates to the type-specific version of
BigList.add(long, Object).
add in interface Collection<K>add in class AbstractObjectBigList<K>k - element whose presence in this collection is to be ensuredpublic K get(long index)
BigListget in interface BigList<K>index - a position in the big list.List.get(int)public long indexOf(Object k)
BigListindexOf in interface BigList<K>indexOf in class AbstractObjectBigList<K>k - the object to search for.List.indexOf(Object)public long lastIndexOf(Object k)
BigListlastIndexOf in interface BigList<K>lastIndexOf in class AbstractObjectBigList<K>k - the object to search for.List.lastIndexOf(Object)public K remove(long index)
AbstractObjectBigList
This implementation always throws an
UnsupportedOperationException.
remove in interface BigList<K>remove in class AbstractObjectBigList<K>index - a position in the big list.List.remove(int)public boolean remove(Object k)
java.util.AbstractCollectionThis implementation iterates over the collection looking for the specified element. If it finds the element, it removes the element from the collection using the iterator's remove method.
Note that this implementation throws an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection contains the specified object.
remove in interface Collection<K>remove in class AbstractCollection<K>k - element to be removed from this collection, if presentpublic K set(long index, K k)
AbstractObjectBigList
This implementation always throws an
UnsupportedOperationException.
set in interface BigList<K>set in class AbstractObjectBigList<K>index - a position in the big list.k - the element to be stored at the specified position.List.set(int,Object)public boolean removeAll(Collection<?> c)
java.util.AbstractCollectionThis implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's so contained, it's removed from this collection with the iterator's remove method.
Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements in common with the specified collection.
removeAll in interface Collection<K>removeAll in class AbstractCollection<K>c - collection containing elements to be removed from this collectionAbstractCollection.remove(Object),
AbstractCollection.contains(Object)public void clear()
AbstractObjectBigListThis implementation iterates over this collection, removing each element using the Iterator.remove operation. Most implementations will probably choose to override this method for efficiency.
Note that this implementation will throw an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection is non-empty.
This implementation delegates to AbstractObjectBigList.removeElements(long, long).
clear in interface Collection<K>clear in class AbstractObjectBigList<K>public long size64()
Size64public void size(long size)
BigListIf 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()
java.util.AbstractCollectionThis implementation returns size() == 0.
isEmpty in interface Stack<K>isEmpty in interface Collection<K>isEmpty in class AbstractCollection<K>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 void getElements(long from,
Object[][] a,
long offset,
long length)
getElements in interface ObjectBigList<K>getElements in class AbstractObjectBigList<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 ObjectBigList<K>removeElements in class AbstractObjectBigList<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 ObjectBigList<K>addElements in class AbstractObjectBigList<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 ObjectBigListIterator<K> listIterator(long index)
AbstractObjectBigList
Note that this specification strengthens the one given in
BigList.listIterator(long).
This implementation is based on the random-access methods.
listIterator in interface BigList<K>listIterator in interface ObjectBigList<K>listIterator in class AbstractObjectBigList<K>index - index of first element to be returned from the big-list iterator.BigList.listIterator(long)public ObjectBigArrayBigList<K> clone()
java.lang.Objectx, the expression:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x)
true, this is not an absolute requirement.
By convention, the returned object should be obtained by calling
super.clone. If a class and all of its superclasses (except
Object) obey this convention, it will be the case that
x.clone().getClass() == x.getClass().
By convention, the object returned by this method should be independent
of this object (which is being cloned). To achieve this independence,
it may be necessary to modify one or more fields of the object returned
by super.clone before returning it. Typically, this means
copying any mutable objects that comprise the internal "deep structure"
of the object being cloned and replacing the references to these
objects with references to the copies. If a class contains only
primitive fields or references to immutable objects, then it is usually
the case that no fields in the object returned by super.clone
need to be modified.
The method clone for class Object performs a
specific cloning operation. First, if the class of this object does
not implement the interface Cloneable, then a
CloneNotSupportedException is thrown. Note that all arrays
are considered to implement the interface Cloneable and that
the return type of the clone method of an array type T[]
is T[] where T is any reference or primitive type.
Otherwise, this method creates a new instance of the class of this
object and initializes all its fields with exactly the contents of
the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method
performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object does not itself implement the interface
Cloneable, so calling the clone method on an object
whose class is Object will result in throwing an
exception at run time.
public boolean equals(ObjectBigArrayBigList<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 int compareTo(ObjectBigArrayBigList<? extends K> l)
This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
l - a big list.