public class MappedList<E,S> extends Object implements XGettingList<E>
XGettingList.Factory<E>XGettingCollection.Creator<E>XIterable.Executor<E>Copyable.Static| Constructor and Description |
|---|
MappedList(XGettingList<S> subject,
Function<S,E> mapper,
Equalator<? super E> equality) |
MappedList(XList<S> subject,
Function<S,E> mapper) |
| 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) |
XGettingList<E> |
copy()
Creates a true copy of this list which references the same elements in the same order as this list does
at the time the method is called.
|
<T extends Consumer<? super E>> |
copySelection(T target,
long... indices)
Iterates through all the elements of the given indices and calls the
Consumer.accept(Object) on the target Consumer. |
<T extends Consumer<? super E>> |
copyTo(T 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.
|
<T extends Consumer<? super E>> |
distinct(T target)
Calls
Consumer.accept(Object) on the target Consumer for all the unique/distinct
elements of this collection. |
<T extends Consumer<? super E>> |
distinct(T 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(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. |
<T extends Consumer<? super E>> |
except(XGettingCollection<? extends E> other,
Equalator<? super E> equalator,
T 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). |
<T extends Consumer<? super E>> |
filterTo(T 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.
|
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) |
<T extends Consumer<? super E>> |
intersect(XGettingCollection<? extends E> other,
Equalator<? super E> equalator,
T 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() |
OldList<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.
|
XGettingList<E> |
range(long fromIndex,
long toIndex) |
long |
remainingCapacity() |
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.
|
long |
size() |
E[] |
toArray(Class<E> type)
Returns a typed array containing all of the elements in this collection.
|
XGettingList<E> |
toReversed()
Creates a new
XGettingSequence with the reversed order of elements. |
<T extends Consumer<? super E>> |
union(XGettingCollection<? extends E> other,
Equalator<? super E> equalator,
T target)
Calls
Consumer.accept(Object) on the target Consumer for all the elements of this collection. |
XGettingList<E> |
view()
Creates a view of this collection and returns it.
|
XGettingList<E> |
view(long lowIndex,
long highIndex)
Creates a sub-view of this collection and returns it.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waithasIndexequals, hashCode, intSize, toArrayforEach, spliteratorpublic MappedList(XGettingList<S> subject, Function<S,E> mapper, Equalator<? super E> equality)
public E at(long index)
at in interface XGettingSequence<E>public E get()
XGettingSequenceat(0).
XGettingSequence.first() is an alias for this method.
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 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 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 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 boolean isSorted(Comparator<? super E> comparator)
XGettingSequenceisSorted in interface XGettingSequence<E>comparator - defines if elements are sortedpublic <T extends Consumer<? super E>> T copySelection(T target, long... indices)
XGettingSequenceConsumer.accept(Object) on the target Consumer.copySelection in interface XGettingSequence<E>T - type of the targettarget - on which the Consumer.accept(Object) is calledindices - of the elements which are copiedpublic 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 long size()
size in interface Sizedsize in interface XGettingCollection<E>public Equalator<? super E> equality()
equality in interface XGettingCollection<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 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 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 containsSearched(Predicate<? super E> predicate)
containsSearched in interface XGettingCollection<E>public boolean containsAll(XGettingCollection<? extends E> elements)
containsAll in interface XGettingCollection<E>elements - to be searched in the collection.Equalator.public boolean applies(Predicate<? super E> predicate)
XGettingCollectionapplies in interface XGettingCollection<E>predicate - that's tested on each element.public 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 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 <T extends Consumer<? super E>> T distinct(T 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>T - type of the targettarget - on which the Consumer.accept(Object) is called for every distinct element of this collection.public <T extends Consumer<? super E>> T distinct(T 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>T - 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 <T extends Consumer<? super E>> T copyTo(T 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>T - type of the targettarget - on which the Consumer.accept(Object) is called for all elements of this collection.public <T extends Consumer<? super E>> T filterTo(T 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>T - 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 extends Consumer<? super E>> T union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T 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>T - type of the targetother - 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 <T extends Consumer<? super E>> T intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T 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>T - type of the targetother - 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 <T extends Consumer<? super E>> T except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T 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>T - type of the targetother - 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 boolean nullAllowed()
ExtendedCollectionnullAllowed in interface ExtendedCollection<E>true if null is allowed inside the collection; false if notpublic long maximumCapacity()
CapacityCarryingInteger.MAX_VALUE)maximumCapacity in interface CapacityCarryingpublic long remainingCapacity()
remainingCapacity in interface CapacityCarryingpublic boolean isFull()
isFull in interface CapacityCarryingpublic XImmutableList<E> immure()
XGettingListIf 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 ListIterator<E> listIterator()
listIterator in interface XGettingList<E>public ListIterator<E> listIterator(long index)
listIterator in interface XGettingList<E>public OldList<E> old()
old in interface XGettingCollection<E>old in interface XGettingList<E>public XGettingList<E> copy()
XGettingSequencecopy in interface XGettingBag<E>copy in interface XGettingCollection<E>copy in interface XGettingList<E>copy in interface XGettingSequence<E>copy in interface Copyablepublic XGettingList<E> toReversed()
XGettingSequenceXGettingSequence with the reversed order of elements.
This method creates a new collection and does not change the existing collection.
toReversed in interface XGettingList<E>toReversed in interface XGettingSequence<E>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)
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 XGettingList<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 XGettingList<E> view(long lowIndex, long highIndex)
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>lowIndex - defines lower boundary for the view of the collection.highIndex - defines higher boundary for the view of the collection.public XGettingList<E> range(long fromIndex, long toIndex)
range in interface XGettingList<E>range in interface XGettingSequence<E>Copyright © 2022 MicroStream Software. All rights reserved.