public final class ArrayAccessor<E> extends AbstractSimpleArrayCollection<E> implements XSettingList<E>
XList.
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, 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 buggy and 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.
Current conclusion is that the JDK's failfast implementations buy unneeded (and even unreliable as stated by
official guides) concurrency modification recognition at the cost of performance loss and even a bug when already
used in a thread-safe manner.
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 |
ArrayAccessor.OldArrayAccessor<E> |
XSettingList.Creator<E>XReplacingBag.Factory<E>Copyable.StaticXIterable.Executor<E>XGettingList.Factory<E>| Constructor and Description |
|---|
ArrayAccessor() |
ArrayAccessor(ArrayAccessor<? extends E> original) |
ArrayAccessor(E... elements) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
applies(Predicate<? super E> predicate)
Tests each element of the collection on the given predicate.
|
E |
at(long index) |
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) |
ArrayAccessor<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.
|
<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. |
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). |
ArrayAccessor<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 one element from the collection.
|
E[] |
getArray() |
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. |
XImmutableList<E> |
immure()
Provides an instance of an immutable collection type with equal behavior and data as this instance.
|
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) |
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) |
boolean |
nullAllowed()
Defines if null-elements are allowed inside the collection or not.
|
boolean |
nullContained() |
ArrayAccessor.OldArrayAccessor<E> |
old() |
E |
peek()
Gets last element or null if the collection is empty.
|
E |
poll()
Gets first element or null if the collection is empty.
|
SubListAccessor<E> |
range(long fromIndex,
long toIndex) |
long |
remainingCapacity() |
long |
replace(E element,
E replacement) |
long |
replace(Predicate<? super E> predicate,
E substitute) |
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) |
ArrayAccessor<E> |
reverse()
Reverses the order of its own elements and returns itself.
|
<T> T[] |
rngCopyTo(int startIndex,
int length,
T[] target,
int offset) |
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) |
ArrayAccessor<E> |
set(long offset,
E[] src,
int srcIndex,
int srcLength) |
ArrayAccessor<E> |
set(long offset,
XGettingSequence<? extends E> elements,
long elementsOffset,
long elementsLength) |
ArrayAccessor<E> |
setAll(long offset,
E... elements) |
ArrayAccessor<E> |
setArray(E[] array) |
void |
setFirst(E element) |
E |
setGet(long index,
E element) |
void |
setLast(E element) |
ArrayAccessor<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. |
ArrayAccessor<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. |
ArrayAccessor<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. |
ArrayAccessor<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() |
ArrayAccessor<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) |
ArrayAccessor<E> |
swap(long indexA,
long indexB) |
ArrayAccessor<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.
|
ArrayAccessor<E> |
toReversed()
Creates a new
XGettingSequence with the reversed order of elements. |
String |
toString() |
<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, waithasIndexintSizeforEach, spliteratorpublic ArrayAccessor()
public ArrayAccessor(ArrayAccessor<? extends E> original) throws NullPointerException
NullPointerException@SafeVarargs public ArrayAccessor(E... elements) throws NullPointerException
NullPointerExceptionpublic E[] getArray()
public Equalator<? super E> equality()
equality in interface XGettingCollection<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 ArrayAccessor<E> setArray(E[] array)
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 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>public ArrayAccessor<E> copy()
XGettingCollectioncopy in interface XGettingBag<E>copy in interface XGettingCollection<E>copy in interface XGettingList<E>copy in interface XGettingSequence<E>copy in interface XReplacingBag<E>copy in interface XSettingList<E>copy in interface XSettingSequence<E>copy in interface XSortableSequence<E>copy in interface Copyablepublic XImmutableList<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>public ArrayAccessor<E> toReversed()
XSortableSequenceXGettingSequence with the reversed order of elements.
This method creates a new collection and does not change the existing collection.
Unlike the XSortableSequence.reverse() method, this method creates a new collection and does not change the
existing collection.
toReversed in interface XGettingList<E>toReversed in interface XGettingSequence<E>toReversed in interface XSettingList<E>toReversed in interface XSettingSequence<E>toReversed in interface XSortableSequence<E>public 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 <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)
XJoinablepublic 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 long count(E element)
XGettingCollectionEqualator.count in interface XGettingCollection<E>element - to countpublic long countBy(Predicate<? super E> predicate)
XGettingCollectioncountBy in interface XGettingCollection<E>predicate - defines which elements are counted and which are notpublic long indexOf(E element)
indexOf in interface XGettingSequence<E>public 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 long lastIndexOf(E element)
lastIndexOf in interface XGettingSequence<E>public 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 long maxIndex(Comparator<? super E> comparator)
maxIndex in interface XGettingSequence<E>public long minIndex(Comparator<? super E> comparator)
minIndex in interface XGettingSequence<E>public 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 E get()
XGettingCollectionXGettingSequence, then it is
undefined which element is returned. If the collection is ordered, the element at index 0 is returned.get in interface XGettingCollection<E>get in interface XGettingSequence<E>XGettingSequence.at(long),
XGettingSequence.first(),
XGettingSequence.last()public E first()
XGettingSequenceIndexOutOfBoundsException if the collection is empty.
Is an alias for XGettingSequence.get().
first in interface XGettingSequence<E>public E last()
XGettingSequenceIndexOutOfBoundsException if the collection is empty.last in interface XGettingSequence<E>public E poll()
XGettingSequencepoll in interface XGettingSequence<E>public E peek()
XGettingSequencepeek in interface XGettingSequence<E>public E search(Predicate<? super E> predicate)
XGettingCollectionsearch in interface XGettingCollection<E>predicate - defines which element is searchedpublic 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 E max(Comparator<? super E> comparator)
max in interface XGettingCollection<E>public E min(Comparator<? super E> comparator)
min in interface XGettingCollection<E>public 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 boolean nullAllowed()
ExtendedCollectionnullAllowed in interface ExtendedCollection<E>true if null is allowed inside the collection; false if notpublic boolean isSorted(Comparator<? super E> comparator)
XGettingSequenceisSorted in interface XGettingSequence<E>comparator - defines if elements are sortedpublic boolean containsSearched(Predicate<? super E> predicate)
containsSearched in interface XGettingCollection<E>public boolean applies(Predicate<? super E> predicate)
XGettingCollectionapplies in interface XGettingCollection<E>predicate - that's tested on each element.public boolean nullContained()
nullContained in interface XGettingCollection<E>public 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 boolean contains(E element)
XGettingCollectionXGettingCollection.containsId(Object) method, this method
uses the internal Equalator defined by the collection itself.contains in interface XGettingCollection<E>element - to be searched in the collectionEqualator.public boolean containsAll(XGettingCollection<? extends E> elements)
containsAll in interface XGettingCollection<E>elements - to be searched in the collection.Equalator.public 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 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 <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 <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 <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 <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 <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 <T> T[] rngCopyTo(int startIndex,
int length,
T[] target,
int offset)
public <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 <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 <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 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>public 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>fromIndex - defines lower boundary for the view of the collection.toIndex - defines higher boundary for the view of the collection.public ArrayAccessor<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 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 ArrayAccessor<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 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 ArrayAccessor<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 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 ArrayAccessor<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 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 ArrayAccessor<E> swap(long indexA, long indexB) throws IndexOutOfBoundsException, ArrayIndexOutOfBoundsException
swap in interface XOrderingSequence<E>swap in interface XSettingList<E>swap in interface XSettingSequence<E>swap in interface XSortableSequence<E>IndexOutOfBoundsExceptionArrayIndexOutOfBoundsExceptionpublic ArrayAccessor<E> swap(long indexA, long indexB, long length)
swap in interface XOrderingSequence<E>swap in interface XSettingList<E>swap in interface XSettingSequence<E>swap in interface XSortableSequence<E>public ArrayAccessor<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 XOrderingSequence<E>reverse in interface XSettingList<E>reverse in interface XSettingSequence<E>reverse in interface XSortableSequence<E>public void setFirst(E element)
setFirst in interface XSettingSequence<E>public void setLast(E element)
setLast in interface XSettingSequence<E>@SafeVarargs public final ArrayAccessor<E> setAll(long offset, E... elements)
setAll in interface XSettingList<E>setAll in interface XSettingSequence<E>public ArrayAccessor<E> set(long offset, E[] src, int srcIndex, int srcLength)
set in interface XSettingList<E>set in interface XSettingSequence<E>public ArrayAccessor<E> set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)
set in interface XSettingList<E>set in interface XSettingSequence<E>public ArrayAccessor<E> fill(long offset, long length, E element)
XSettingListnull.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 ArrayAccessor<E> sort(Comparator<? super E> comparator)
Sortablesort in interface Sortable<E>sort in interface XSettingList<E>sort in interface XSettingSequence<E>sort in interface XSortableSequence<E>comparator - to sort this collectionpublic boolean replaceOne(E element, E replacement)
XReplacingBagreplaceOne in interface XReplacingBag<E>element - to replacereplacement - for the found elementtrue if element is found, false if notpublic boolean replaceOne(Predicate<? super E> predicate, E substitute)
replaceOne in interface XReplacingBag<E>public long replace(E element, E replacement)
replace in interface XReplacingBag<E>public long replace(Predicate<? super E> predicate, E substitute)
replace in interface XReplacingBag<E>public long replaceAll(XGettingCollection<? extends E> elements, E replacement)
replaceAll in interface XReplacingBag<E>public long substitute(Function<? super E,? extends E> mapper)
substitute in interface XReplacingCollection<E>public long substitute(Predicate<? super E> predicate, Function<E,E> mapper)
substitute in interface XReplacingBag<E>public ListIterator<E> listIterator()
listIterator in interface XGettingList<E>public ListIterator<E> listIterator(long index)
listIterator in interface XGettingList<E>public boolean set(long index,
E element)
throws IndexOutOfBoundsException,
ArrayIndexOutOfBoundsException
set in interface XSettingSequence<E>IndexOutOfBoundsExceptionArrayIndexOutOfBoundsExceptionpublic E setGet(long index, E element) throws IndexOutOfBoundsException, ArrayIndexOutOfBoundsException
setGet in interface XSettingSequence<E>IndexOutOfBoundsExceptionArrayIndexOutOfBoundsExceptionpublic long size()
size in interface Sizedsize in interface XGettingCollection<E>public long maximumCapacity()
CapacityCarryingInteger.MAX_VALUE)maximumCapacity in interface CapacityCarryingpublic boolean isFull()
isFull in interface CapacityCarryingpublic long remainingCapacity()
remainingCapacity in interface CapacityCarryingpublic SubListAccessor<E> range(long fromIndex, long toIndex)
range in interface XGettingList<E>range in interface XGettingSequence<E>range in interface XSettingList<E>range in interface XSettingSequence<E>public 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 E at(long index) throws ArrayIndexOutOfBoundsException
at in interface XGettingSequence<E>ArrayIndexOutOfBoundsException@Deprecated public 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 int hashCode()
hashCode in interface XGettingCollection<E>hashCode in class Objectpublic ArrayAccessor.OldArrayAccessor<E> old()
old in interface XGettingCollection<E>old in interface XGettingList<E>Copyright © 2022 MicroStream Software. All rights reserved.