E - type of contained elementspublic final class BulkList<E> extends AbstractSimpleArrayCollection<E> implements XList<E>, Composition, IdentityEqualityLogic
List.
Full scale general purpose implementation of extended collection type XList.
In contrast to EqBulkList this implementation uses the default isSame-Equalator(Equalator.identity()
This array-backed implementation is optimal for all needs of a list that do not require frequent structural
modification (insert or remove) of single elements before the end of the list.
It is recommended to use this implementation as default list type until concrete performance deficiencies are
identified. If used properly (e.g. always ensure enough capacity, make use of batch procedures like
inputAll(long, Object...), removeRange(long, long), etc.), this implementation has equal or
massively superior performance to linked-list implementation is most cases.
This implementation is not synchronized and thus should only be used by a
single thread or in a thread-safe manner (i.e. read-only as soon as multiple threads access it).
See SynchList wrapper class to use a list in a synchronized manner.
Note that this List implementation does not keep track of modification count as JDK's collection implementations do
(and thus never throws a ConcurrentModificationException), for two reasons:
1.) It is already explicitly declared thread-unsafe and for single-thread (or thread-safe)
use only.
2.) The common modCount-concurrency exception behavior ("failfast") has inconsistent behavior by
throwing ConcurrentModificationException even in single thread use, i.e. when iterating over a collection
and removing more than one element of it without using the iterator's method.
Also note that by being an extended collection, this implementation offers various functional and batch procedures
to maximize internal iteration potential, eliminating the need to use the ill-conceived external iteration
Iterator paradigm.
| Modifier and Type | Class and Description |
|---|---|
static class |
BulkList.Creator<E> |
static class |
BulkList.OldBulkList<E> |
static class |
BulkList.Supplier<K,E> |
XBag.Factory<E>XPutGetList.Factory<E>XInputtingList.Factory<E>XProcessingList.Factory<E>XBasicSequence.Factory<E>| Constructor and Description |
|---|
BulkList()
Default constructor instantiating an empty instance with default (minimum) capacity.
|
BulkList(BulkList<? extends E> original)
Copy constructor that instantiates a new instance with a copy of the passed original instance's data and same
size.
|
BulkList(E... elements)
Convenience initial data constructor, instantiating a new instance containing all elements of the passed
array.
|
BulkList(E initialElement)
Default constructor instantiating an instance with default (minimum) capacity
and the given element already included.
|
BulkList(int initialCapacity)
Initial capacity constructor instantiating an empty instance with a given initial capacity.
|
BulkList(int initialCapacity,
E[] src,
int srcStart,
int srcLength)
Detailed initializing constructor allowing to specify initial capacity and a custom array range of initial data.
|
| Modifier and Type | Method and Description |
|---|---|
void |
accept(E element) |
boolean |
add(E element)
Adds the passed element.
|
BulkList<E> |
addAll(E... elements) |
BulkList<E> |
addAll(E[] elements,
int offset,
int length) |
BulkList<E> |
addAll(XGettingCollection<? extends E> elements) |
boolean |
applies(Predicate<? super E> predicate)
Tests each element of the collection on the given predicate.
|
E |
at(long index) |
static <E> Aggregator<E,BulkList<E>> |
Builder()
Creates an
Aggregator that accepts elements and adds them to a new BulkList. |
static <E> Aggregator<E,BulkList<E>> |
Builder(long initialCapacity)
Creates a
Aggregator that accepts elements and adds them to a new BulkList
with a specific initial capacity. |
void |
clear()
Clears all elements from the collection while leaving the capacity as it is.
|
Aggregator<E,BulkList<E>> |
collector() |
long |
consolidate()
Consolidates the internal storage of this collection by discarding all elements of the internal storage that
have become obsolete or otherwise unneeded anymore.
|
boolean |
contains(E element)
Checks if the given element is contained in the collection.
|
boolean |
containsAll(XGettingCollection<? extends E> elements) |
boolean |
containsId(E element)
Special version of contains() that guarantees to use identity comparison (" == ") when searching for the
given element regardless of the collection's internal logic.
This method has the same behavior as XGettingCollection.containsSearched(Predicate) with a Predicate implementation
that checks for object identity. |
boolean |
containsSearched(Predicate<? super E> predicate) |
BulkList<E> |
copy()
Creates a true copy of this collection which references the same elements as this collection does
at the time the method is called.
|
<C extends Consumer<? super E>> |
copySelection(C target,
long... indices)
Iterates through all the elements of the given indices and calls the
Consumer.accept(Object) on the target Consumer. |
<C extends Consumer<? super E>> |
copyTo(C target)
Calls
Consumer.accept(Object) on the target Consumer for all the elements of this collection. |
long |
count(E element)
Count how many times this element matches another element in the collection
using the
Equalator. |
long |
countBy(Predicate<? super E> predicate)
Count how many matches are found using the given predicate on each element of the collection.
|
long |
currentCapacity()
Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.
|
<C extends Consumer<? super E>> |
distinct(C target)
Calls
Consumer.accept(Object) on the target Consumer for all the unique/distinct
elements of this collection. |
<C extends Consumer<? super E>> |
distinct(C target,
Equalator<? super E> equalator)
Calls
Consumer.accept(Object) on the target Consumer for all the unique/distinct
elements of this collection. |
BulkList<E> |
ensureCapacity(long minCapacity) |
BulkList<E> |
ensureFreeCapacity(long requiredFreeCapacity)
Ensures that the next minimalFreeCapacity elements can be actually added in a fast way,
meaning for example no internal storage rebuild will be necessary.
|
Equalator<? super E> |
equality() |
boolean |
equals(Object o)
Deprecated.
|
boolean |
equals(XGettingCollection<? extends E> samples,
Equalator<? super E> equalator) |
boolean |
equalsContent(XGettingCollection<? extends E> samples,
Equalator<? super E> equalator)
Returns
true if all elements of this list and the passed list are sequentially equal as defined
by the passed equalator. |
<C extends Consumer<? super E>> |
except(XGettingCollection<? extends E> samples,
Equalator<? super E> equalator,
C target)
Calls
Consumer.accept(Object) on the target Consumer for each
element of this collection that is not contained in the other collection (through the given equalator). |
E |
fetch() |
BulkList<E> |
fill(long offset,
long length,
E element)
Fills all slots from the offset to the offset+length with the given element,
regardless of whether or not a slot is
null. |
<C extends Consumer<? super E>> |
filterTo(C target,
Predicate<? super E> predicate)
Calls
Consumer.accept(Object) on the target Consumer for all the elements of this collection
which test true on the given predicate. |
E |
first()
Gets first element or throws
IndexOutOfBoundsException if the collection is empty. |
E |
get()
Gets the first element in the collection.
|
int |
hashCode()
Deprecated.
|
boolean |
hasVolatileElements()
Tells if this collection contains volatile elements.
An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. |
ConstList<E> |
immure()
Provides an instance of an immutable collection type with equal behavior and data as this instance.
|
static <E> Function<BulkList<E>,ConstList<E>> |
Immurer() |
long |
indexBy(Predicate<? super E> predicate)
Iterates forwards through the collection and returns the index of the first element that the passed {link Predicate}
applies to immediately.
Stops iterating on the first element that the predicate applies to. |
long |
indexOf(E element) |
boolean |
input(long index,
E element) |
long |
inputAll(long index,
E... elements) |
long |
inputAll(long index,
E[] elements,
int offset,
int length) |
long |
inputAll(long index,
XGettingCollection<? extends E> elements) |
boolean |
insert(long index,
E element) |
long |
insertAll(long index,
E... elements) |
long |
insertAll(long index,
E[] elements,
int offset,
int length) |
long |
insertAll(long index,
XGettingCollection<? extends E> elements) |
protected int |
internalCountingAddAll(E[] elements) |
protected int |
internalCountingAddAll(E[] elements,
int offset,
int length) |
protected int |
internalCountingAddAll(XGettingCollection<? extends E> elements) |
protected int |
internalCountingPutAll(E[] elements) |
protected int |
internalCountingPutAll(E[] elements,
int offset,
int length) |
protected int |
internalCountingPutAll(XGettingCollection<? extends E> elements) |
protected int[] |
internalGetSectionIndices()
Defines the array sections in which the collection's elements are organized by one or more pairs of
indices in the order corresponding to the collection's logical order of its contained elements.
|
protected E[] |
internalGetStorageArray()
This is an internal shortcut method to provide fast access to the various array-backed list implementations'
storage arrays.
The purpose of this method is to allow access to the array only for read-only procedures, never for modifying accesses. |
protected int |
internalSize() |
<C extends Consumer<? super E>> |
intersect(XGettingCollection<? extends E> samples,
Equalator<? super E> equalator,
C target)
Tests equality between each element of the two lists and calls
Consumer.accept(Object) on the target Consumer for the
equal elements.Therefore it effectively creates a mathematical intersection between the two collections. |
boolean |
isEmpty() |
boolean |
isFull() |
boolean |
isSorted(Comparator<? super E> comparator)
Tests if the collection is sorted according to the given comparator.
|
<P extends Consumer<? super E>> |
iterate(P procedure)
Executes the given procedure for each element of the
XIterable
until all elements have been processed or the action throws an
exception. |
<P extends IndexedAcceptor<? super E>> |
iterateIndexed(P procedure)
Iterates over elements with the
IndexedAcceptor to use
not only the element itself but also its coherent index. |
Iterator<E> |
iterator() |
<A> A |
join(BiConsumer<? super E,? super A> joiner,
A aggregate)
Iterates over all elements of the collections and calls the joiner
with each element and the aggregate.
|
E |
last()
Gets last element or throws
IndexOutOfBoundsException if the collection is empty. |
long |
lastIndexBy(Predicate<? super E> predicate)
Iterates backwards through the collection and returns the index of the last element that the passed
Predicate
applies to immediately.Stops iterating on the first element that the predicate applies to. |
long |
lastIndexOf(E element) |
ListIterator<E> |
listIterator() |
ListIterator<E> |
listIterator(long index) |
E |
max(Comparator<? super E> comparator) |
long |
maximumCapacity()
Returns the maximum amount of elements this carrier instance can contain.
The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g. |
long |
maxIndex(Comparator<? super E> comparator) |
E |
min(Comparator<? super E> comparator) |
long |
minIndex(Comparator<? super E> comparator) |
<C extends Consumer<? super E>> |
moveSelection(C target,
long... indices) |
<C extends Consumer<? super E>> |
moveTo(C target,
Predicate<? super E> predicate) |
static <E> BulkList<E> |
New()
Pseudo-constructor method to create a new
BulkList instance with default (minimum) capacity. |
static <E> BulkList<E> |
New(E... initialElements)
Pseudo-constructor method to create a new
BulkList instance containing all elements of the passed
array. |
static <E> BulkList<E> |
New(Iterable<? extends E> initialElements)
Pseudo-constructor method to create a new
BulkList instance and adds all the given elements to it. |
static <E> BulkList<E> |
New(long initialCapacity)
Pseudo-constructor method to create a new
BulkList instance with a given initial capacity. |
static <E> BulkList<E> |
New(XGettingCollection<? extends E> initialElements)
Pseudo-constructor method to create a new
BulkList instance with the needed amount of capacity and adds all
elements to it. |
static <E> BulkList<E> |
New(XIterable<? extends E> initialElements)
Pseudo-constructor method to create a new
BulkList instance and adds all the given elements to it. |
static <E> BulkList<E> |
NewFromSingle(E initialElement)
Pseudo-constructor method to create a new
BulkList instance with default (minimum) capacity
and the given element already included. |
boolean |
nullAdd() |
boolean |
nullAllowed()
Defines if null-elements are allowed inside the collection or not.
|
boolean |
nullContained() |
boolean |
nullInput(long index) |
boolean |
nullInsert(long index) |
boolean |
nullPrepend() |
boolean |
nullPreput() |
boolean |
nullPut() |
long |
nullRemove() |
BulkList.OldBulkList<E> |
old() |
long |
optimize()
Optimizes the internal storage of this collection and returns the storage size of the collection after the
process is complete.
|
E |
peek()
Gets last element or null if the collection is empty.
|
E |
pick() |
E |
pinch() |
E |
poll()
Gets first element or null if the collection is empty.
|
E |
pop() |
boolean |
prepend(E element) |
BulkList<E> |
prependAll(E... elements) |
BulkList<E> |
prependAll(E[] elements,
int offset,
int length) |
BulkList<E> |
prependAll(XGettingCollection<? extends E> elements) |
boolean |
preput(E element) |
BulkList<E> |
preputAll(E... elements) |
BulkList<E> |
preputAll(E[] elements,
int offset,
int length) |
BulkList<E> |
preputAll(XGettingCollection<? extends E> elements) |
<P extends Consumer<? super E>> |
process(P procedure) |
boolean |
put(E element)
Adds the specified element to this collection if it is not already present (optional operation).
|
BulkList<E> |
putAll(E... elements)
Adds the specified elements to this collection if it is not already present (optional operation).
|
BulkList<E> |
putAll(E[] elements,
int offset,
int length)
Adds the specified elements to this collection if it is not already present (optional operation).
Only the elements with indizes from the srcStartIndex to the srcStartIndex+srcLength are put in the collection. |
BulkList<E> |
putAll(XGettingCollection<? extends E> elements)
Adds the specified elements to this collection if it is not already present (optional operation).
|
SubList<E> |
range(long fromIndex,
long toIndex) |
long |
remove(E element) |
long |
removeAll(XGettingCollection<? extends E> elements) |
E |
removeAt(long index) |
long |
removeBy(Predicate<? super E> predicate) |
long |
removeDuplicates() |
long |
removeDuplicates(Equalator<? super E> equalator) |
boolean |
removeOne(E element) |
BulkList<E> |
removeRange(long startIndex,
long length) |
long |
removeSelection(long[] indices) |
long |
replace(E element,
E replacement) |
long |
replace(Predicate<? super E> predicate,
E replacement) |
long |
replaceAll(XGettingCollection<? extends E> elements,
E replacement) |
boolean |
replaceOne(E element,
E replacement)
Replaces the first element that is equal to the given element
with the replacement and then returns true.
|
boolean |
replaceOne(Predicate<? super E> predicate,
E substitute) |
long |
retainAll(XGettingCollection<? extends E> elements)
Removing all elements except the ones contained in the given elements-collection.
|
BulkList<E> |
retainRange(long startIndex,
long length)
Removing all elements but the ones from the offset (basically start index)
to the offset+length (end index).
|
E |
retrieve(E element) |
E |
retrieveBy(Predicate<? super E> predicate) |
BulkList<E> |
reverse()
Reverses the order of its own elements and returns itself.
|
long |
scan(Predicate<? super E> predicate)
Iterates through the collection and returns the index of the last element that the passed
Predicate
applied to ("scanning"). |
E |
search(Predicate<? super E> predicate)
Returns the first contained element matching the passed predicate.
|
E |
seek(E sample)
Returns the first contained element matching the passed sample as defined by the collection's equality logic
or null, if no fitting element is contained.
|
boolean |
set(long index,
E element) |
BulkList<E> |
set(long offset,
E[] src,
int srcIndex,
int srcLength) |
BulkList<E> |
set(long offset,
XGettingSequence<? extends E> elements,
long elementsOffset,
long elementsLength) |
BulkList<E> |
setAll(long offset,
E... elements) |
void |
setFirst(E element) |
E |
setGet(long index,
E element) |
void |
setLast(E element) |
BulkList<E> |
shiftBy(long sourceIndex,
long distance)
Moves the element from the sourceIndex in the sequence to a higher index position.
All other elements are possibly moved to create the empty slot for the shifting element. |
BulkList<E> |
shiftBy(long sourceIndex,
long distance,
long length)
Moves multiple elements from the sourceIndex in the sequence to a higher index position.
All other elements are possibly moved to create the empty slot for the shifting elements. |
BulkList<E> |
shiftTo(long sourceIndex,
long targetIndex)
Moves the element from the sourceIndex in the sequence to the targetIndex.
All other elements are possibly moved to create the empty slot for the shifting element. |
BulkList<E> |
shiftTo(long sourceIndex,
long targetIndex,
long length)
Moves multiple elements from the sourceIndex in the sequence to the targetIndex.
All other elements are possibly moved to create the empty slot for the shifting element. |
long |
size() |
BulkList<E> |
sort(Comparator<? super E> comparator)
Sorts this collection according to the given comparator
and returns itself.
|
long |
substitute(Function<? super E,? extends E> mapper) |
long |
substitute(Predicate<? super E> predicate,
Function<E,E> mapper) |
BulkList<E> |
swap(long indexA,
long indexB) |
BulkList<E> |
swap(long indexA,
long indexB,
long length) |
Object[] |
toArray()
Returns an array containing all of the elements in this collection.
|
E[] |
toArray(Class<E> type)
Returns a typed array containing all of the elements in this collection.
|
BulkList<E> |
toReversed()
Creates a new
XBasicList with the reversed order of elements. |
String |
toString() |
void |
truncate()
Clears (and reinitializes if needed) this collection in the fastest possible way, i.e.
|
<C extends Consumer<? super E>> |
union(XGettingCollection<? extends E> samples,
Equalator<? super E> equalator,
C target)
Calls
Consumer.accept(Object) on the target Consumer for all the elements of this collection. |
ListView<E> |
view()
Creates a view of this collection and returns it.
|
SubListView<E> |
view(long fromIndex,
long toIndex)
Creates a sub-view of this collection and returns it.
|
internalGetStorageArraymarker, newArray, newArray, pow2BoundMaxedensureFreeArrayCapacity, validateIndexclone, finalize, getClass, notify, notifyAll, wait, wait, waitcurrentFreeCapacityremainingCapacitysortIfApplicablepublic BulkList()
public BulkList(E initialElement)
initialElement - that will be included in the listpublic BulkList(int initialCapacity)
The actual initial capacity is the highest of the following three values:
Integer MAX_VALUE, if the given initial capacity is greater than 2^30.initialCapacity - the desired custom initial capacity.public BulkList(BulkList<? extends E> original) throws NullPointerException
original - the instance to be copied.NullPointerException - if null was passed.copy()@SafeVarargs public BulkList(E... elements) throws NullPointerException
Note that providing no element at all in the VarArgs parameter will automatically cause the
default constructor BulkList() to be used instead. Explicitly providing an null array
reference will cause a NullPointerException.
elements - the initial elements for the new instance.NullPointerException - if an explicit null array reference was passed.BulkList()public BulkList(int initialCapacity,
E[] src,
int srcStart,
int srcLength)
The actual initial capacity will be calculated based on the higher of the two values initialCapacity
and srcLength as described in BulkList(int).
The specified initial elements array range is copied via System.arraycopy(Object, int, Object, int, int).
initialCapacity - the desired initial capacity for the new instance.src - the source array containg the desired range of initial elements.srcStart - the start index of the desired range of initial elements in the source array.srcLength - the length of the desired range of initial elements in the source array.public static <E> Function<BulkList<E>,ConstList<E>> Immurer()
E - type of contained elementsBulkListpublic static <E> Aggregator<E,BulkList<E>> Builder()
Aggregator that accepts elements and adds them to a new BulkList.E - type of contained elementspublic static <E> Aggregator<E,BulkList<E>> Builder(long initialCapacity)
Aggregator that accepts elements and adds them to a new BulkList
with a specific initial capacity.E - type of contained elementsinitialCapacity - of the listpublic static final <E> BulkList<E> New()
BulkList instance with default (minimum) capacity.E - type of contained elementsBulkList instance.public static final <E> BulkList<E> New(long initialCapacity)
BulkList instance with a given initial capacity.E - type of contained elementsinitialCapacity - the desired custom initial capacity.BulkList instance.public static final <E> BulkList<E> NewFromSingle(E initialElement)
BulkList instance with default (minimum) capacity
and the given element already included.E - type of contained elementsinitialElement - that will be included in the listBulkList instance.@SafeVarargs public static final <E> BulkList<E> New(E... initialElements)
BulkList instance containing all elements of the passed
array. The element size of the new instance will be equal to the passed arrays length.E - type of contained elementsinitialElements - the initial elements for the new instance.BulkList instance.NullPointerException - if an explicit null array reference was passed.public static final <E> BulkList<E> New(XIterable<? extends E> initialElements)
BulkList instance and adds all the given elements to it.E - type of contained elementsinitialElements - to add to the created instanceBulkList instance.public static final <E> BulkList<E> New(Iterable<? extends E> initialElements)
BulkList instance and adds all the given elements to it.E - type of contained elementsinitialElements - to add to the created instanceBulkList instance.public static final <E> BulkList<E> New(XGettingCollection<? extends E> initialElements)
BulkList instance with the needed amount of capacity and adds all
elements to it.E - type of contained elementsinitialElements - to add to the created instanceBulkList instance.protected E[] internalGetStorageArray()
AbstractSimpleArrayCollectionThe returned array is expected to contain the elements of the list in simple order from index 0 on to index (size - 1), so for example an array-backed ring list (queue) can NOT (reasonably) extend this class.
internalGetStorageArray in class AbstractSimpleArrayCollection<E>protected final int internalSize()
internalSize in class AbstractSimpleArrayCollection<E>protected int[] internalGetSectionIndices()
AbstractSectionedArrayCollection
Examples:
The trivial example would be {0,size} in case of standard sized array collections.
An example for actual sectioning would be {i,array.length - 1, 0,i - 1} in case of a ring buffer list
comprised of two sections: one ranging from index i to array.length - 1 (with the oldest element located at i)
and one ranging from 0 to i - 1 (with the newest element located at i - 1).
internalGetSectionIndices in class AbstractSectionedArrayCollection<E>protected int internalCountingAddAll(E[] elements) throws UnsupportedOperationException
internalCountingAddAll in class AbstractExtendedCollection<E>UnsupportedOperationExceptionprotected int internalCountingAddAll(E[] elements, int offset, int length) throws UnsupportedOperationException
internalCountingAddAll in class AbstractExtendedCollection<E>UnsupportedOperationExceptionprotected int internalCountingAddAll(XGettingCollection<? extends E> elements) throws UnsupportedOperationException
internalCountingAddAll in class AbstractExtendedCollection<E>UnsupportedOperationExceptionprotected int internalCountingPutAll(E[] elements) throws UnsupportedOperationException
internalCountingPutAll in class AbstractExtendedCollection<E>UnsupportedOperationExceptionprotected int internalCountingPutAll(E[] elements, int offset, int length) throws UnsupportedOperationException
internalCountingPutAll in class AbstractExtendedCollection<E>UnsupportedOperationExceptionprotected int internalCountingPutAll(XGettingCollection<? extends E> elements) throws UnsupportedOperationException
internalCountingPutAll in class AbstractExtendedCollection<E>UnsupportedOperationExceptionpublic final Equalator<? super E> equality()
equality in interface XGettingCollection<E>Equalator for this collection instance,
which in this case is always a '=='-operation. (identity check)public final BulkList<E> copy()
XGettingCollectioncopy in interface XAddGetCollection<E>copy in interface XBag<E>copy in interface XBasicList<E>copy in interface XBasicSequence<E>copy in interface XCollection<E>copy in interface XDecreasingList<E>copy in interface XDecreasingSequence<E>copy in interface XGettingBag<E>copy in interface XGettingCollection<E>copy in interface XGettingList<E>copy in interface XGettingSequence<E>copy in interface XIncreasingList<E>copy in interface XIncreasingSequence<E>copy in interface XList<E>copy in interface XProcessingBag<E>copy in interface XProcessingList<E>copy in interface XPutGetCollection<E>copy in interface XPutGetList<E>copy in interface XPutGetSequence<E>copy in interface XReplacingBag<E>copy in interface XSequence<E>copy in interface XSettingList<E>copy in interface XSettingSequence<E>copy in interface XSortableSequence<E>copy in interface Copyablepublic final ConstList<E> immure()
XGettingCollectionIf this instance already is of an immutable collection type, it returns itself.
immure in interface XGettingBag<E>immure in interface XGettingCollection<E>immure in interface XGettingList<E>immure in interface XGettingSequence<E>immure in interface XProcessingBag<E>public final BulkList<E> toReversed()
XBasicListXBasicList with the reversed order of elements.
This method creates a new collection and does not change the
existing collection.
Furthermore changes to the reversed collection do not reflect to the original.
toReversed in interface XBasicList<E>toReversed in interface XBasicSequence<E>toReversed in interface XDecreasingList<E>toReversed in interface XDecreasingSequence<E>toReversed in interface XGettingList<E>toReversed in interface XGettingSequence<E>toReversed in interface XIncreasingList<E>toReversed in interface XIncreasingSequence<E>toReversed in interface XList<E>toReversed in interface XProcessingList<E>toReversed in interface XProcessingSequence<E>toReversed in interface XPutGetList<E>toReversed in interface XPutGetSequence<E>toReversed in interface XSequence<E>toReversed in interface XSettingList<E>toReversed in interface XSettingSequence<E>toReversed in interface XSortableSequence<E>public final E[] toArray(Class<E> type)
XGettingCollectionThe returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
This method acts as bridge between MicroStream-based collections and Java-native-based APIs.
toArray in interface XGettingCollection<E>type - the Class representing type E at runtime.public final <P extends Consumer<? super E>> P iterate(P procedure)
XIterableXIterable
until all elements have been processed or the action throws an
exception. Unless otherwise specified by the implementing class,
procedures are performed in the order of iteration (if an iteration order
is specified). Exceptions thrown by the procedure are relayed to the
caller.Iterable.forEach(Consumer).public final <A> A join(BiConsumer<? super E,? super A> joiner, A aggregate)
join in interface XGettingCollection<E>join in interface XJoinable<E>A - type of aggregatejoiner - is the actual function to do the joiningaggregate - where to join intoAbstractArrayStorage.join(Object[], int, BiConsumer, Object)public final <P extends IndexedAcceptor<? super E>> P iterateIndexed(P procedure)
XIndexIterableIndexedAcceptor to use
not only the element itself but also its coherent index.iterateIndexed in interface XIndexIterable<E>P - type of procedureprocedure - which is executed when iteratingpublic final long count(E element)
Equalator.NullPointerException if element is null.count in interface XGettingCollection<E>element - to countpublic final long countBy(Predicate<? super E> predicate)
NullPointerException if predicate is null.countBy in interface XGettingCollection<E>predicate - defines which elements are counted and which are notpublic final long indexOf(E element)
indexOf in interface XGettingSequence<E>public final long indexBy(Predicate<? super E> predicate)
XGettingSequence
Basically the opposite of XGettingSequence.lastIndexBy(Predicate)
indexBy in interface XGettingSequence<E>predicate - to define a valid elementpublic final long lastIndexOf(E element)
lastIndexOf in interface XGettingSequence<E>public final long lastIndexBy(Predicate<? super E> predicate)
XGettingSequencePredicate
applies to immediately.
Basically the opposite of XGettingSequence.indexBy(Predicate).
Similar but not the same as XGettingSequence.scan(Predicate), since scan iterates through all elements.
lastIndexBy in interface XGettingSequence<E>predicate - to define a valid elementpublic final long maxIndex(Comparator<? super E> comparator)
maxIndex in interface XGettingSequence<E>public final long minIndex(Comparator<? super E> comparator)
minIndex in interface XGettingSequence<E>public final long scan(Predicate<? super E> predicate)
XGettingSequencePredicate
applied to ("scanning").
In order to find the last element, this method must iterate over all elements of the collection
(opposed to XGettingSequence.indexBy(Predicate) and XGettingSequence.lastIndexBy(Predicate)).
Iteration can be safely canceled with a ThrowBreak (X.BREAK)
scan in interface XGettingSequence<E>predicate - to define a valid elementpublic final E get() throws NoSuchElementException
at(0).
first() is an alias for this method.
get in interface XGettingCollection<E>get in interface XGettingSequence<E>NoSuchElementException - if collection is emptyat(long),
first(),
last()public final E first() throws IndexBoundsException
XGettingSequenceIndexOutOfBoundsException if the collection is empty.
Is an alias for XGettingSequence.get().
first in interface XGettingSequence<E>IndexBoundsExceptionpublic final E last() throws IndexBoundsException
XGettingSequenceIndexOutOfBoundsException if the collection is empty.last in interface XGettingSequence<E>IndexBoundsExceptionpublic final E poll()
XGettingSequencepoll in interface XGettingSequence<E>public final E peek()
XGettingSequencepeek in interface XGettingSequence<E>public final E search(Predicate<? super E> predicate)
XGettingCollectionsearch in interface XGettingCollection<E>predicate - defines which element is searchedpublic final E seek(E sample)
XGettingCollectionXGettingCollection.contains(Object) with a different return type. For collections with data-dependant equality,
the returned element might be the same as the passed one or a data-wise equal one, depending on the content
of the collection)seek in interface XGettingCollection<E>sample - to seek in the collectionpublic final E max(Comparator<? super E> comparator)
max in interface XGettingCollection<E>public final E min(Comparator<? super E> comparator)
min in interface XGettingCollection<E>public final boolean hasVolatileElements()
ExtendedCollectionWeakReference of SoftReference or implementations of collection entries
that remove the element contained in an entry by some means outside the collection.WeakReference instances that are added to a a simple (non-volatile) implementation of a
collection do not make the collection volatile, as the elements themselves (the reference instances) are still
strongly referenced.hasVolatileElements in interface ExtendedCollection<E>hasVolatileElements in interface XGettingCollection<E>true if the collection contains volatile elements.public final boolean nullAllowed()
ExtendedCollectionnullAllowed in interface ExtendedCollection<E>BulkList, because null is generally allowed.public final boolean isSorted(Comparator<? super E> comparator)
XGettingSequenceisSorted in interface XGettingSequence<E>comparator - defines if elements are sortedpublic final boolean containsSearched(Predicate<? super E> predicate)
containsSearched in interface XGettingCollection<E>public final boolean applies(Predicate<? super E> predicate)
XGettingCollectionapplies in interface XGettingCollection<E>predicate - that's tested on each element.public final boolean nullContained()
nullContained in interface XGettingCollection<E>public final boolean containsId(E element)
XGettingCollectionXGettingCollection.containsSearched(Predicate) with a Predicate implementation
that checks for object identity. The only difference is a performance and usability advantagecontainsId in interface XGettingCollection<E>element - the element to be searched in the collection by identity.public final boolean contains(E element)
XGettingCollection.containsId(Object) method, this method
uses the internal Equalator defined by the collection itself.
In BulkList this method is identical to the containsId(Object) method,
since the Equalator is the default Equalator.identity().
contains in interface XGettingCollection<E>element - to be searched in the collectionEqualator.public final boolean containsAll(XGettingCollection<? extends E> elements)
containsAll in interface XGettingCollection<E>elements - to be searched in the collection.Equalator.public final boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
equals in interface XGettingCollection<E>samples - is the collection which is checked for equalityequalator - is used to check the equality of the collectionstrue if the passed collection is of the same type as this collection and
this.equalsContent(list, equalator) yields truepublic final boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
XGettingCollectiontrue if all elements of this list and the passed list are sequentially equal as defined
by the passed equalator.
Note that for colletion types that don't have a defined order of elements, this method is hardly usable
(as is XGettingCollection.equals(Object) for them as defined in Collection). The core problem of comparing
collections that have no defined order is that they aren't really reliably comparable to any other collection.
equalsContent in interface XGettingCollection<E>samples - is the collection which is checked for equalityequalator - the equalator to use to determine the equality of each elementtrue if this list is equal to the passed list, false otherwisepublic final <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
XGettingCollectionConsumer.accept(Object) on the target Consumer for the
equal elements.
Since all MicroStream Collections implement the Consumer interface,
new collections can be used as target.
Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3); BulkList<Integer> collection2 = BulkList.New(2,3,4); BulkList<Integer> intersection = collection1.intersect(collection2, Equalator.identity(), BulkList.New());Results in
intersection containing 2 and 3.intersect in interface XGettingCollection<E>C - type of the targetsamples - collection to intersect with.equalator - which is used for the equal-tests.target - on which the Consumer.accept(Object) is called for equal elements.public final <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
XGettingCollectionConsumer.accept(Object) on the target Consumer for each
element of this collection that is not contained in the other collection (through the given equalator).
Since all MicroStream Collections implement the Consumer interface,
new collections can be used as target.
Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3); BulkList<Integer> collection2 = BulkList.New(2,3,4); BulkList<Integer> exceptCollection = collection1.except(collection2, Equalator.identity(), BulkList.New());Results in
exceptCollection containing 1.except in interface XGettingCollection<E>C - type of the targetsamples - collection whose elements are excluded from the target.equalator - which is used for the equal-tests.target - on which the Consumer.accept(Object) is called for elements not contained in the other collection.public final <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
XGettingCollectionConsumer.accept(Object) on the target Consumer for all the elements of this collection.
And calls it for all elements of the other collection, that are not already in this collection
(defined by the given Equalator)
Since all MicroStream Collections implement the Consumer interface,
new collections can be used as target.
Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3); BulkList<Integer> collection2 = BulkList.New(2,3,4); BulkList<Integer> union = collection1.union(collection2, Equalator.identity(), BulkList.New());Results in
union containing 1, 2, 3 and 4.union in interface XGettingCollection<E>C - type of the targetsamples - collection to build a union with.equalator - which is used for the equal-tests.target - on which the Consumer.accept(Object) is called for all unified elements.public final <C extends Consumer<? super E>> C copyTo(C target)
XGettingCollectionConsumer.accept(Object) on the target Consumer for all the elements of this collection.
Since all MicroStream Collections implement the Consumer interface,
new collections can be used as target.
Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3); BulkList<Integer> copiedCollection = collection1.copyTo(BulkList.New());Results in
copiedCollection containing 1, 2 and 3.copyTo in interface XGettingCollection<E>C - type of the targettarget - on which the Consumer.accept(Object) is called for all elements of this collection.public final <C extends Consumer<? super E>> C filterTo(C target, Predicate<? super E> predicate)
XGettingCollectionConsumer.accept(Object) on the target Consumer for all the elements of this collection
which test true on the given predicate.
Since all MicroStream Collections implement the Consumer interface,
new collections can be used as target.
Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3); BulkList<Integer> filteredCollection = collection1.filterTo(BulkList.New(), e-> e % 2 == 0);Results in
filteredCollection containing 2.filterTo in interface XGettingCollection<E>C - type of the targettarget - on which the Consumer.accept(Object) is called for elements that test true.predicate - on which to test all elements.public final <C extends Consumer<? super E>> C distinct(C target)
XGettingCollectionConsumer.accept(Object) on the target Consumer for all the unique/distinct
elements of this collection. This means the elements are not equal to each other.Equalator.
Since all MicroStream Collections implement the Consumer interface,
new collections can be used as target.
Example:
BulkList<Integer> collection1 = BulkList.New(1,2,2,3);
BulkList<Integer> distinctCollection = collection1.distinct(BulkList.New());
Results in distinctCollection containing 1, 2 and 3.
distinct in interface XGettingCollection<E>C - type of the targettarget - on which the Consumer.accept(Object) is called for every distinct element of this collection.public final <C extends Consumer<? super E>> C distinct(C target, Equalator<? super E> equalator)
XGettingCollectionConsumer.accept(Object) on the target Consumer for all the unique/distinct
elements of this collection. This means the elements are not equal to each other.Equalator.
Since all MicroStream Collections implement the Consumer interface,
new collections can be used as target.
Example:
BulkList<Integer> collection1 = BulkList.New(1,2,2,3); BulkList<Integer> distinctCollection = collection1.distinct(BulkList.New(), Equalator.identity());Results in
distinctCollection containing 1, 2 and 3.distinct in interface XGettingCollection<E>C - type of the targettarget - on which the Consumer.accept(Object) is called for every distinct element of this collection.equalator - defines what distinct means (which elements are equal to one another)public final <C extends Consumer<? super E>> C copySelection(C target, long... indices)
XGettingSequenceConsumer.accept(Object) on the target Consumer.copySelection in interface XGettingSequence<E>C - type of the targettarget - on which the Consumer.accept(Object) is calledindices - of the elements which are copiedpublic final ListView<E> view()
XGettingCollection
A view is different from immutable collection (XGettingCollection.immure())
in the way, that changes in this collection are still affecting the view.
The immutable collection on the other hand has no reference to this collection
and changes therefore do not affect the immutable collection.
view in interface XGettingBag<E>view in interface XGettingCollection<E>view in interface XGettingList<E>view in interface XGettingSequence<E>view in interface XProcessingBag<E>public final SubListView<E> view(long fromIndex, long toIndex)
XGettingSequence
A view is different from immutable collection (XGettingCollection.immure())
in the way, that changes in this collection are still affecting the view.
The immutable collection on the other hand has no reference to this collection
and changes therefore do not affect the immutable collection.
view in interface XGettingList<E>view in interface XGettingSequence<E>view in interface XProcessingSequence<E>fromIndex - defines lower boundary for the view of the collection.toIndex - defines higher boundary for the view of the collection.public final BulkList<E> shiftTo(long sourceIndex, long targetIndex)
XOrderingSequenceDoes not expand or shrink the capacity of the sequence.
Throws a IndexExceededException if sourceIndex or targetIndex are
greater than the size of the sequence.
shiftTo in interface XList<E>shiftTo in interface XOrderingSequence<E>shiftTo in interface XSortableSequence<E>sourceIndex - points to the source element; Index of the source elementtargetIndex - points to the target element; Index of the target elementpublic final BulkList<E> shiftTo(long sourceIndex, long targetIndex, long length)
XOrderingSequenceDoes not expand or shrink the capacity of the sequence.
Throws a IndexExceededException if sourceIndex or targetIndex
exceed the size of the sequence.
shiftTo in interface XList<E>shiftTo in interface XOrderingSequence<E>shiftTo in interface XSortableSequence<E>sourceIndex - points to the source element; Index of the source elementtargetIndex - points to the target element; Index of the target elementlength - Amount of moved elements.public final BulkList<E> shiftBy(long sourceIndex, long distance)
XOrderingSequenceDoes not expand or shrink the capacity of the sequence.
Throws a IndexExceededException if sourceIndex or targetIndex
(sourceIndex+distance) exceed the size of the sequence.
shiftBy in interface XList<E>shiftBy in interface XOrderingSequence<E>shiftBy in interface XSortableSequence<E>sourceIndex - points to the source element; Index of the source elementdistance - of how far the element should be moved.
Example: 1 moves the element from position 21 to position 22public final BulkList<E> shiftBy(long sourceIndex, long distance, long length)
XOrderingSequenceDoes not expand or shrink the capacity of the sequence.
Throws a IndexExceededException if sourceIndex or targetIndex
(sourceIndex+distance+length) exceed the size of the sequence.
shiftBy in interface XList<E>shiftBy in interface XOrderingSequence<E>shiftBy in interface XSortableSequence<E>sourceIndex - points to the source element; Index of the source elementdistance - of how far the element should be moved.
Example: 1 moves the element from position 21 to position 22length - Amount of moved elements.public final BulkList<E> swap(long indexA, long indexB) throws IndexOutOfBoundsException, ArrayIndexOutOfBoundsException
swap in interface XDecreasingList<E>swap in interface XDecreasingSequence<E>swap in interface XIncreasingList<E>swap in interface XIncreasingSequence<E>swap in interface XList<E>swap in interface XOrderingSequence<E>swap in interface XSettingList<E>swap in interface XSettingSequence<E>swap in interface XSortableSequence<E>IndexOutOfBoundsExceptionArrayIndexOutOfBoundsExceptionpublic final BulkList<E> swap(long indexA, long indexB, long length)
swap in interface XDecreasingList<E>swap in interface XDecreasingSequence<E>swap in interface XIncreasingList<E>swap in interface XIncreasingSequence<E>swap in interface XList<E>swap in interface XOrderingSequence<E>swap in interface XSettingList<E>swap in interface XSettingSequence<E>swap in interface XSortableSequence<E>public final BulkList<E> reverse()
XSortableSequence
Unlike the XSortableSequence.toReversed() method, this method does not create a new collection,
but changes the order of its own elements.
reverse in interface XDecreasingList<E>reverse in interface XDecreasingSequence<E>reverse in interface XIncreasingList<E>reverse in interface XIncreasingSequence<E>reverse in interface XList<E>reverse in interface XOrderingSequence<E>reverse in interface XSettingList<E>reverse in interface XSettingSequence<E>reverse in interface XSortableSequence<E>public final void setFirst(E element)
setFirst in interface XSettingSequence<E>public final void setLast(E element)
setLast in interface XSettingSequence<E>@SafeVarargs public final BulkList<E> setAll(long offset, E... elements)
setAll in interface XDecreasingList<E>setAll in interface XDecreasingSequence<E>setAll in interface XIncreasingList<E>setAll in interface XList<E>setAll in interface XSettingList<E>setAll in interface XSettingSequence<E>public final BulkList<E> set(long offset, E[] src, int srcIndex, int srcLength)
set in interface XDecreasingList<E>set in interface XDecreasingSequence<E>set in interface XIncreasingList<E>set in interface XList<E>set in interface XSettingList<E>set in interface XSettingSequence<E>public final BulkList<E> set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)
set in interface XDecreasingList<E>set in interface XDecreasingSequence<E>set in interface XIncreasingList<E>set in interface XList<E>set in interface XSettingList<E>set in interface XSettingSequence<E>public final BulkList<E> fill(long offset, long length, E element)
XSettingListnull.fill in interface XDecreasingList<E>fill in interface XIncreasingList<E>fill in interface XList<E>fill in interface XSettingList<E>offset - from the start of the collection (start index)length - of how many slots should be filledelement - to use for filling of slotspublic final BulkList<E> sort(Comparator<? super E> comparator)
Sortablesort in interface Sortable<E>sort in interface XDecreasingList<E>sort in interface XDecreasingSequence<E>sort in interface XIncreasingList<E>sort in interface XIncreasingSequence<E>sort in interface XList<E>sort in interface XSequence<E>sort in interface XSettingList<E>sort in interface XSettingSequence<E>sort in interface XSortableSequence<E>comparator - to sort this collectionpublic final boolean replaceOne(E element, E replacement)
If the element is equal is defined by a '==' comparation (same).
replaceOne in interface XReplacingBag<E>element - to replacereplacement - for the found elementtrue if element is found, false if notpublic final boolean replaceOne(Predicate<? super E> predicate, E substitute)
replaceOne in interface XReplacingBag<E>public final long replace(E element, E replacement)
replace in interface XReplacingBag<E>public final long replace(Predicate<? super E> predicate, E replacement)
replace in interface XReplacingBag<E>public final long replaceAll(XGettingCollection<? extends E> elements, E replacement)
replaceAll in interface XReplacingBag<E>public final long substitute(Function<? super E,? extends E> mapper)
substitute in interface XReplacingCollection<E>public final long substitute(Predicate<? super E> predicate, Function<E,E> mapper)
substitute in interface XReplacingBag<E>public final long currentCapacity()
CapacityExtendable
For carrier implementations that don't have a concept of storage rebuilding (like linked list for example)
this method returns the same value as CapacityCarrying.maximumCapacity().
currentCapacity in interface CapacityExtendablepublic final long maximumCapacity()
CapacityCarryingInteger.MAX_VALUE)maximumCapacity in interface CapacityCarryingpublic final boolean isFull()
isFull in interface CapacityCarryingpublic final long optimize()
OptimizableCollectionoptimize in interface OptimizableCollectionoptimize in interface XRemovingCollection<E>public final BulkList<E> ensureFreeCapacity(long requiredFreeCapacity)
CapacityExtendableensureFreeCapacity in interface CapacityExtendablerequiredFreeCapacity - the capacity to ensurepublic final BulkList<E> ensureCapacity(long minCapacity)
ensureCapacity in interface CapacityExtendablepublic final void accept(E element)
public final boolean add(E element)
XAddingCollectionadd in interface XAddingCollection<E>element - to addtrue if element was added; false if not@SafeVarargs public final BulkList<E> addAll(E... elements)
addAll in interface XAddGetCollection<E>addAll in interface XAddingBag<E>addAll in interface XAddingCollection<E>addAll in interface XAddingList<E>addAll in interface XAddingSequence<E>addAll in interface XBag<E>addAll in interface XBasicList<E>addAll in interface XBasicSequence<E>addAll in interface XCollection<E>addAll in interface XExpandingList<E>addAll in interface XExpandingSequence<E>addAll in interface XExtendingList<E>addAll in interface XExtendingSequence<E>addAll in interface XIncreasingList<E>addAll in interface XIncreasingSequence<E>addAll in interface XInputtingList<E>addAll in interface XInputtingSequence<E>addAll in interface XInsertingSequence<E>addAll in interface XList<E>addAll in interface XPutGetCollection<E>addAll in interface XPutGetList<E>addAll in interface XPutGetSequence<E>addAll in interface XPuttingBag<E>addAll in interface XPuttingList<E>addAll in interface XSequence<E>public final BulkList<E> addAll(E[] elements, int offset, int length)
addAll in interface XAddGetCollection<E>addAll in interface XAddingBag<E>addAll in interface XAddingCollection<E>addAll in interface XAddingList<E>addAll in interface XAddingSequence<E>addAll in interface XBag<E>addAll in interface XBasicList<E>addAll in interface XBasicSequence<E>addAll in interface XCollection<E>addAll in interface XExpandingList<E>addAll in interface XExpandingSequence<E>addAll in interface XExtendingList<E>addAll in interface XExtendingSequence<E>addAll in interface XIncreasingList<E>addAll in interface XIncreasingSequence<E>addAll in interface XInputtingList<E>addAll in interface XInputtingSequence<E>addAll in interface XInsertingSequence<E>addAll in interface XList<E>addAll in interface XPutGetCollection<E>addAll in interface XPutGetList<E>addAll in interface XPutGetSequence<E>addAll in interface XPuttingBag<E>addAll in interface XPuttingList<E>addAll in interface XSequence<E>public final BulkList<E> addAll(XGettingCollection<? extends E> elements)
addAll in interface XAddGetCollection<E>addAll in interface XAddingBag<E>addAll in interface XAddingCollection<E>addAll in interface XAddingList<E>addAll in interface XAddingSequence<E>addAll in interface XBag<E>addAll in interface XBasicList<E>addAll in interface XBasicSequence<E>addAll in interface XCollection<E>addAll in interface XExpandingList<E>addAll in interface XExpandingSequence<E>addAll in interface XExtendingList<E>addAll in interface XExtendingSequence<E>addAll in interface XIncreasingList<E>addAll in interface XIncreasingSequence<E>addAll in interface XInputtingList<E>addAll in interface XInputtingSequence<E>addAll in interface XInsertingSequence<E>addAll in interface XList<E>addAll in interface XPutGetCollection<E>addAll in interface XPutGetList<E>addAll in interface XPutGetSequence<E>addAll in interface XPuttingBag<E>addAll in interface XPuttingList<E>addAll in interface XSequence<E>public final boolean nullAdd()
nullAdd in interface XAddingCollection<E>public final boolean nullPut()
nullPut in interface XPuttingCollection<E>public final boolean put(E element)
In this implementation it is identical to add(Object).
put in interface XPuttingCollection<E>element - to add@SafeVarargs public final BulkList<E> putAll(E... elements)
XPuttingBag
In this implementation it is identical to XPuttingBag.addAll(Object...)
putAll in interface XBag<E>putAll in interface XBasicList<E>putAll in interface XBasicSequence<E>putAll in interface XCollection<E>putAll in interface XExpandingList<E>putAll in interface XExpandingSequence<E>putAll in interface XIncreasingList<E>putAll in interface XIncreasingSequence<E>putAll in interface XInputtingList<E>putAll in interface XInputtingSequence<E>putAll in interface XList<E>putAll in interface XPutGetCollection<E>putAll in interface XPutGetList<E>putAll in interface XPutGetSequence<E>putAll in interface XPuttingBag<E>putAll in interface XPuttingCollection<E>putAll in interface XPuttingList<E>putAll in interface XPuttingSequence<E>putAll in interface XSequence<E>elements - to addpublic final BulkList<E> putAll(E[] elements, int offset, int length)
XPuttingBag
In this implementation it is identical to XPuttingBag.addAll(Object[], int, int)
putAll in interface XBag<E>putAll in interface XBasicList<E>putAll in interface XBasicSequence<E>putAll in interface XCollection<E>putAll in interface XExpandingList<E>putAll in interface XExpandingSequence<E>putAll in interface XIncreasingList<E>putAll in interface XIncreasingSequence<E>putAll in interface XInputtingList<E>putAll in interface XInputtingSequence<E>putAll in interface XList<E>putAll in interface XPutGetCollection<E>putAll in interface XPutGetList<E>putAll in interface XPutGetSequence<E>putAll in interface XPuttingBag<E>putAll in interface XPuttingCollection<E>putAll in interface XPuttingList<E>putAll in interface XPuttingSequence<E>putAll in interface XSequence<E>elements - to addoffset - start index of elements-array to add to collectionlength - length of elements-array to add to collectionpublic final BulkList<E> putAll(XGettingCollection<? extends E> elements)
XPuttingBag
In this implementation it is identical to XPuttingBag.addAll(XGettingCollection)
putAll in interface XBag<E>putAll in interface XBasicList<E>putAll in interface XBasicSequence<E>putAll in interface XCollection<E>putAll in interface XExpandingList<E>putAll in interface XExpandingSequence<E>putAll in interface XIncreasingList<E>putAll in interface XIncreasingSequence<E>putAll in interface XInputtingList<E>putAll in interface XInputtingSequence<E>putAll in interface XList<E>putAll in interface XPutGetCollection<E>putAll in interface XPutGetList<E>putAll in interface XPutGetSequence<E>putAll in interface XPuttingBag<E>putAll in interface XPuttingCollection<E>putAll in interface XPuttingList<E>putAll in interface XPuttingSequence<E>putAll in interface XSequence<E>elements - to addpublic final boolean prepend(E element)
prepend in interface XPrependingSequence<E>@SafeVarargs public final BulkList<E> prependAll(E... elements)
prependAll in interface XExpandingList<E>prependAll in interface XExpandingSequence<E>prependAll in interface XExtendingList<E>prependAll in interface XExtendingSequence<E>prependAll in interface XIncreasingList<E>prependAll in interface XIncreasingSequence<E>prependAll in interface XInputtingList<E>prependAll in interface XInputtingSequence<E>prependAll in interface XInsertingSequence<E>prependAll in interface XList<E>prependAll in interface XPrependingList<E>prependAll in interface XPrependingSequence<E>prependAll in interface XPreputtingList<E>prependAll in interface XPreputtingSequence<E>public final BulkList<E> prependAll(E[] elements, int offset, int length)
prependAll in interface XExpandingList<E>prependAll in interface XExpandingSequence<E>prependAll in interface XExtendingList<E>prependAll in interface XExtendingSequence<E>prependAll in interface XIncreasingList<E>prependAll in interface XIncreasingSequence<E>prependAll in interface XInputtingList<E>prependAll in interface XInputtingSequence<E>prependAll in interface XInsertingSequence<E>prependAll in interface XList<E>prependAll in interface XPrependingList<E>prependAll in interface XPrependingSequence<E>prependAll in interface XPreputtingList<E>prependAll in interface XPreputtingSequence<E>public final BulkList<E> prependAll(XGettingCollection<? extends E> elements)
prependAll in interface XExpandingList<E>prependAll in interface XExpandingSequence<E>prependAll in interface XExtendingList<E>prependAll in interface XExtendingSequence<E>prependAll in interface XIncreasingList<E>prependAll in interface XIncreasingSequence<E>prependAll in interface XInputtingList<E>prependAll in interface XInputtingSequence<E>prependAll in interface XInsertingSequence<E>prependAll in interface XList<E>prependAll in interface XPrependingList<E>prependAll in interface XPrependingSequence<E>prependAll in interface XPreputtingList<E>prependAll in interface XPreputtingSequence<E>public final boolean nullPrepend()
nullPrepend in interface XPrependingSequence<E>public final boolean preput(E element)
preput in interface XPreputtingSequence<E>@SafeVarargs public final BulkList<E> preputAll(E... elements)
preputAll in interface XExpandingList<E>preputAll in interface XExpandingSequence<E>preputAll in interface XIncreasingList<E>preputAll in interface XIncreasingSequence<E>preputAll in interface XInputtingList<E>preputAll in interface XInputtingSequence<E>preputAll in interface XList<E>preputAll in interface XPreputtingList<E>preputAll in interface XPreputtingSequence<E>public final BulkList<E> preputAll(E[] elements, int offset, int length)
preputAll in interface XExpandingList<E>preputAll in interface XExpandingSequence<E>preputAll in interface XIncreasingList<E>preputAll in interface XIncreasingSequence<E>preputAll in interface XInputtingList<E>preputAll in interface XInputtingSequence<E>preputAll in interface XList<E>preputAll in interface XPreputtingList<E>preputAll in interface XPreputtingSequence<E>public final BulkList<E> preputAll(XGettingCollection<? extends E> elements)
preputAll in interface XExpandingList<E>preputAll in interface XExpandingSequence<E>preputAll in interface XIncreasingList<E>preputAll in interface XIncreasingSequence<E>preputAll in interface XInputtingList<E>preputAll in interface XInputtingSequence<E>preputAll in interface XList<E>preputAll in interface XPreputtingList<E>preputAll in interface XPreputtingSequence<E>public final boolean nullPreput()
nullPreput in interface XPreputtingSequence<E>public final boolean insert(long index,
E element)
insert in interface XInsertingSequence<E>@SafeVarargs public final long insertAll(long index, E... elements) throws IndexOutOfBoundsException
insertAll in interface XInsertingSequence<E>IndexOutOfBoundsExceptionpublic final long insertAll(long index,
E[] elements,
int offset,
int length)
insertAll in interface XInsertingSequence<E>public final long insertAll(long index,
XGettingCollection<? extends E> elements)
insertAll in interface XInsertingSequence<E>public final boolean nullInsert(long index)
nullInsert in interface XInsertingSequence<E>public final boolean input(long index,
E element)
input in interface XInputtingSequence<E>@SafeVarargs public final long inputAll(long index, E... elements) throws IndexOutOfBoundsException
inputAll in interface XInputtingSequence<E>IndexOutOfBoundsExceptionpublic final long inputAll(long index,
E[] elements,
int offset,
int length)
inputAll in interface XInputtingSequence<E>public final long inputAll(long index,
XGettingCollection<? extends E> elements)
inputAll in interface XInputtingSequence<E>public final boolean nullInput(long index)
nullInput in interface XInputtingSequence<E>public final void truncate()
XRemovingCollectiontruncate in interface Truncateabletruncate in interface XRemovingCollection<E>public final long consolidate()
WeakReference entries whose reference has
been cleared).
In a BulkList, this does nothing.
consolidate in interface ConsolidatableCollectionconsolidate in interface XRemovingCollection<E>public final boolean removeOne(E element)
removeOne in interface XRemovingCollection<E>public final E retrieve(E element)
retrieve in interface XProcessingCollection<E>public final E retrieveBy(Predicate<? super E> predicate)
retrieveBy in interface XProcessingCollection<E>public final long remove(E element)
remove in interface XRemovingCollection<E>public final long nullRemove()
nullRemove in interface XRemovingCollection<E>public final E removeAt(long index) throws IndexOutOfBoundsException, ArrayIndexOutOfBoundsException
removeAt in interface XProcessingSequence<E>IndexOutOfBoundsExceptionArrayIndexOutOfBoundsExceptionpublic final long removeBy(Predicate<? super E> predicate)
removeBy in interface XProcessingCollection<E>public final long retainAll(XGettingCollection<? extends E> elements)
XRemovingCollectionBasically intersect this collection with the given collection and only keeping the resulting elements.
retainAll in interface XRemovingCollection<E>elements - to retainpublic final <P extends Consumer<? super E>> P process(P procedure)
process in interface Processable<E>public final <C extends Consumer<? super E>> C moveTo(C target, Predicate<? super E> predicate)
moveTo in interface XProcessingCollection<E>public final <C extends Consumer<? super E>> C moveSelection(C target, long... indices)
moveSelection in interface XProcessingSequence<E>public final long removeAll(XGettingCollection<? extends E> elements)
removeAll in interface XRemovingCollection<E>public final long removeDuplicates(Equalator<? super E> equalator)
removeDuplicates in interface XProcessingCollection<E>public final long removeDuplicates()
removeDuplicates in interface XRemovingCollection<E>public final E fetch()
fetch in interface XProcessingCollection<E>public final E pop()
pop in interface XProcessingSequence<E>public final E pinch()
pinch in interface XProcessingCollection<E>public final E pick()
pick in interface XProcessingSequence<E>public final long removeSelection(long[] indices)
removeSelection in interface XRemovingSequence<E>public final BulkList<E> removeRange(long startIndex, long length)
removeRange in interface XRemovingSequence<E>public final BulkList<E> retainRange(long startIndex, long length)
XRemovingSequenceretainRange in interface XList<E>retainRange in interface XRemovingSequence<E>startIndex - is the index of the first element to retainlength - is the amount of elements to retainpublic final SubList<E> range(long fromIndex, long toIndex)
range in interface XDecreasingList<E>range in interface XDecreasingSequence<E>range in interface XGettingList<E>range in interface XGettingSequence<E>range in interface XIncreasingList<E>range in interface XIncreasingSequence<E>range in interface XList<E>range in interface XSettingList<E>range in interface XSettingSequence<E>public final ListIterator<E> listIterator()
listIterator in interface XGettingList<E>public final ListIterator<E> listIterator(long index) throws IndexBoundsException
listIterator in interface XGettingList<E>IndexBoundsExceptionpublic final E at(long index) throws IndexBoundsException
at in interface XGettingSequence<E>IndexBoundsExceptionpublic final boolean set(long index,
E element)
throws IndexBoundsException
set in interface XSettingSequence<E>IndexBoundsExceptionpublic final E setGet(long index, E element) throws IndexBoundsException
setGet in interface XSettingSequence<E>IndexBoundsExceptionpublic final long size()
size in interface Sizedsize in interface XGettingCollection<E>public final Object[] toArray()
XGettingCollectionThe returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
This method acts as bridge between MicroStream-based collections and Java-native-based APIs.
toArray in interface XGettingCollection<E>public final void clear()
XRemovingCollectionclear in interface XRemovingCollection<E>clear in interface Clearable@Deprecated public final boolean equals(Object o)
XGettingCollectionCollection.
Note that it is this interface's author opinion that the whole concept of equals() in standard Java, especially
in the collection implementations, is flawed.
The reason is because all different kinds of comparison types that actually depend on the situation
have to be mixed up in a harcoded fashion in one method, from identity comparison over
data indentity comparison to content comparison.
In order to get the right behavior in every situation, one has to distinct between different types of equality
This means several things:
1.) You can't just say for example an ArrayList is the "same" as a LinkedList just because they contain the
same content.
There are different implementations for a good reason, so you have to distinct them when comparing.
There are simple code examples which create massive misbehavior that will catastrophically ruin the runtime
behavior of a programm due to this error in Java / JDK / Sun / whatever.
2.) You can't always determine equality of two collections by determining equality of each element as
Collection defines it.
As a conclusion: don't use this method!
Be clear what type of comparison you really need, then use one of the following methods
and proper comparators:
XGettingCollection.equals(XGettingCollection, Equalator)
XGettingCollection.equalsContent(XGettingCollection, Equalator)
equals in interface XGettingCollection<E>equals in class Objecto - the reference object with which to compare.@Deprecated public final int hashCode()
hashCode in interface XGettingCollection<E>hashCode in class Objectpublic final BulkList.OldBulkList<E> old()
old in interface XGettingCollection<E>old in interface XGettingList<E>public final Aggregator<E,BulkList<E>> collector()
collector in interface XAddingCollection<E>collector in interface XCollection<E>collector in interface XList<E>Copyright © 2022 MicroStream Software. All rights reserved.