E - the type of elements in this collectionpublic class Singleton<E> extends Object implements XReference<E>
As there is always only one element, this type can be a List and a Set (Enum) at the same time, enabling it to be used in any type situation. .
ConstantXSettingList.Creator<E>XReplacingBag.Factory<E>XIterable.Executor<E>XGettingList.Factory<E>XSortableEnum.Creator<E>| Modifier | Constructor and Description |
|---|---|
protected |
Singleton(E element) |
| 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) |
Singleton<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). |
Singleton<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. |
<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()
Convenience alias for
first(). |
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. |
Constant<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) |
static <E> Singleton<E> |
New(E element) |
boolean |
nullAllowed()
Defines if null-elements are allowed inside the collection or not.
|
boolean |
nullContained() |
one.microstream.collections.Singleton.OldSingleton |
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.
|
Singleton<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) |
Singleton<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.
|
void |
set(E element) |
boolean |
set(long index,
E element) |
Singleton<E> |
set(long index,
E[] elements,
int offset,
int length) |
Singleton<E> |
set(long index,
XGettingSequence<? extends E> elements,
long offset,
long length) |
Singleton<E> |
setAll(long index,
E... elements) |
void |
setFirst(E element) |
E |
setGet(long index,
E element) |
void |
setLast(E element) |
Singleton<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. |
Singleton<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. |
Singleton<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. |
Singleton<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() |
Singleton<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) |
Singleton<E> |
swap(long indexA,
long indexB) |
Singleton<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.
|
Singleton<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. |
SingletonView<E> |
view()
Creates a view of this collection and returns it.
|
SingletonView<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, waitaccepthasIndexprotected Singleton(E element)
public final E get()
first().get in interface XGettingCollection<E>get in interface XGettingSequence<E>get in interface XReferencing<E>get in interface Referencing<E>XGettingSequence.at(long),
XGettingSequence.first(),
XGettingSequence.last()public final Singleton<E> copy()
XGettingSequencecopy in interface XGettingBag<E>copy in interface XGettingCollection<E>copy in interface XGettingEnum<E>copy in interface XGettingList<E>copy in interface XGettingSequence<E>copy in interface XGettingSet<E>copy in interface XReference<E>copy in interface XReferencing<E>copy in interface XReplacingBag<E>copy in interface XSettingList<E>copy in interface XSettingSequence<E>copy in interface XSortableEnum<E>copy in interface XSortableSequence<E>copy in interface Copyablepublic 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).iterate in interface XGettingEnum<E>iterate in interface XGettingSet<E>iterate in interface XIterable<E>P - type of procedureprocedure - The procedure to be performed for each elementpublic 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 final Constant<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 XGettingEnum<E>immure in interface XGettingList<E>immure in interface XGettingSequence<E>immure in interface XGettingSet<E>immure in interface XReference<E>immure in interface XReferencing<E>public final ListIterator<E> listIterator()
listIterator in interface XGettingList<E>listIterator in interface XReference<E>listIterator in interface XReferencing<E>public final ListIterator<E> listIterator(long index)
listIterator in interface XGettingList<E>listIterator in interface XReference<E>listIterator in interface XReferencing<E>public final one.microstream.collections.Singleton.OldSingleton old()
old in interface XGettingCollection<E>old in interface XGettingList<E>old in interface XReference<E>old in interface XReferencing<E>public final Singleton<E> range(long fromIndex, long toIndex)
range in interface XGettingEnum<E>range in interface XGettingList<E>range in interface XGettingSequence<E>range in interface XReference<E>range in interface XReferencing<E>range in interface XSettingList<E>range in interface XSettingSequence<E>public final Singleton<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 XGettingEnum<E>toReversed in interface XGettingList<E>toReversed in interface XGettingSequence<E>toReversed in interface XReference<E>toReversed in interface XReferencing<E>toReversed in interface XSettingList<E>toReversed in interface XSettingSequence<E>toReversed in interface XSortableEnum<E>toReversed in interface XSortableSequence<E>public final <T extends Consumer<? super E>> T copySelection(T target, long... indices)
XGettingSequenceConsumer.accept(Object) on the target Consumer.copySelection in interface XGettingSequence<E>copySelection in interface XReference<E>copySelection in interface XReferencing<E>T - type of the targettarget - on which the Consumer.accept(Object) is calledindices - of the elements which are copiedpublic final E first()
XGettingSequenceIndexOutOfBoundsException if the collection is empty.
Is an alias for XGettingSequence.get().
first in interface XGettingSequence<E>first in interface XReference<E>first in interface XReferencing<E>public final E at(long index)
at in interface XGettingSequence<E>at in interface XReference<E>at in interface XReferencing<E>public final long indexOf(E element)
indexOf in interface XGettingSequence<E>indexOf in interface XReference<E>indexOf in interface XReferencing<E>public final long indexBy(Predicate<? super E> predicate)
XGettingSequence
Basically the opposite of XGettingSequence.lastIndexBy(Predicate)
indexBy in interface XGettingSequence<E>indexBy in interface XReference<E>indexBy in interface XReferencing<E>predicate - to define a valid elementpublic final boolean isSorted(Comparator<? super E> comparator)
XGettingSequenceisSorted in interface XGettingSequence<E>isSorted in interface XReference<E>isSorted in interface XReferencing<E>comparator - defines if elements are sortedpublic final E last()
XGettingSequenceIndexOutOfBoundsException if the collection is empty.last in interface XGettingSequence<E>last in interface XReference<E>last in interface XReferencing<E>public final long lastIndexOf(E element)
lastIndexOf in interface XGettingSequence<E>lastIndexOf in interface XReference<E>lastIndexOf in interface XReferencing<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>lastIndexBy in interface XReference<E>lastIndexBy in interface XReferencing<E>predicate - to define a valid elementpublic final long maxIndex(Comparator<? super E> comparator)
maxIndex in interface XGettingSequence<E>maxIndex in interface XReference<E>maxIndex in interface XReferencing<E>public final long minIndex(Comparator<? super E> comparator)
minIndex in interface XGettingSequence<E>minIndex in interface XReference<E>minIndex in interface XReferencing<E>public final E peek()
XGettingSequencepeek in interface XGettingSequence<E>peek in interface XReference<E>peek in interface XReferencing<E>public final E poll()
XGettingSequencepoll in interface XGettingSequence<E>poll in interface XReference<E>poll in interface XReferencing<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>scan in interface XReference<E>scan in interface XReferencing<E>predicate - to define a valid elementpublic final SingletonView<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 XGettingEnum<E>view in interface XGettingList<E>view in interface XGettingSequence<E>view in interface XReference<E>view in interface XReferencing<E>public final SingletonView<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 XGettingEnum<E>view in interface XGettingList<E>view in interface XGettingSequence<E>view in interface XReference<E>view in interface XReferencing<E>lowIndex - defines lower boundary for the view of the collection.highIndex - defines higher boundary for the view of the collection.public final boolean containsSearched(Predicate<? super E> predicate)
containsSearched in interface XGettingCollection<E>containsSearched in interface XReference<E>containsSearched in interface XReferencing<E>public final boolean applies(Predicate<? super E> predicate)
XGettingCollectionapplies in interface XGettingCollection<E>applies in interface XReference<E>applies in interface XReferencing<E>predicate - that's tested on each element.public final boolean contains(E element)
XGettingCollectionXGettingCollection.containsId(Object) method, this method
uses the internal Equalator defined by the collection itself.contains in interface XGettingCollection<E>contains in interface XReference<E>contains in interface XReferencing<E>element - to be searched in the collectionEqualator.public final boolean containsAll(XGettingCollection<? extends E> elements)
containsAll in interface XGettingCollection<E>containsAll in interface XReference<E>containsAll in interface XReferencing<E>elements - to be searched in the collection.Equalator.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>containsId in interface XReference<E>containsId in interface XReferencing<E>element - the element to be searched in the collection by identity.public final <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>copyTo in interface XReference<E>copyTo in interface XReferencing<E>T - type of the targettarget - on which the Consumer.accept(Object) is called for all elements of this collection.public final <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>filterTo in interface XReference<E>filterTo in interface XReferencing<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 final long count(E element)
XGettingCollectionEqualator.count in interface XGettingCollection<E>count in interface XReference<E>count in interface XReferencing<E>element - to countpublic final long countBy(Predicate<? super E> predicate)
XGettingCollectioncountBy in interface XGettingCollection<E>countBy in interface XReference<E>countBy in interface XReferencing<E>predicate - defines which elements are counted and which are notpublic final <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>distinct in interface XReference<E>distinct in interface XReferencing<E>T - type of the targettarget - on which the Consumer.accept(Object) is called for every distinct element of this collection.public final <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>distinct in interface XReference<E>distinct in interface XReferencing<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 final Equalator<? super E> equality()
equality in interface XGettingCollection<E>equality in interface XReference<E>equality in interface XReferencing<E>public final boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
equals in interface XGettingCollection<E>equals in interface XReference<E>equals in interface XReferencing<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>equalsContent in interface XReference<E>equalsContent in interface XReferencing<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 <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>except in interface XReference<E>except in interface XReferencing<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 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>hasVolatileElements in interface XReference<E>hasVolatileElements in interface XReferencing<E>true if the collection contains volatile elements.public final <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>intersect in interface XReference<E>intersect in interface XReferencing<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 final boolean isEmpty()
isEmpty in interface SizedisEmpty in interface XReference<E>isEmpty in interface XReferencing<E>public Iterator<E> iterator()
iterator in interface Iterable<E>iterator in interface XGettingCollection<E>iterator in interface XReference<E>iterator in interface XReferencing<E>public final E max(Comparator<? super E> comparator)
max in interface XGettingCollection<E>max in interface XReference<E>max in interface XReferencing<E>public final E min(Comparator<? super E> comparator)
min in interface XGettingCollection<E>min in interface XReference<E>min in interface XReferencing<E>public final boolean nullContained()
nullContained in interface XGettingCollection<E>nullContained in interface XReference<E>nullContained in interface XReferencing<E>public 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>seek in interface XReference<E>seek in interface XReferencing<E>sample - to seek in the collectionpublic final E search(Predicate<? super E> predicate)
XGettingCollectionsearch in interface XGettingCollection<E>search in interface XReference<E>search in interface XReferencing<E>predicate - defines which element is searchedpublic final long size()
size in interface Sizedsize in interface XGettingCollection<E>size in interface XReference<E>size in interface XReferencing<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>toArray in interface XReference<E>toArray in interface XReferencing<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>toArray in interface XReference<E>toArray in interface XReferencing<E>type - the Class representing type E at runtime.public final <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>union in interface XReference<E>union in interface XReferencing<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 final boolean nullAllowed()
ExtendedCollectionnullAllowed in interface ExtendedCollection<E>nullAllowed in interface XReference<E>nullAllowed in interface XReferencing<E>true if null is allowed inside the collection; false if notpublic final long remainingCapacity()
remainingCapacity in interface CapacityCarryingremainingCapacity in interface XReference<E>remainingCapacity in interface XReferencing<E>public final boolean isFull()
isFull in interface CapacityCarryingisFull in interface XReference<E>isFull in interface XReferencing<E>public final long maximumCapacity()
CapacityCarryingInteger.MAX_VALUE)maximumCapacity in interface CapacityCarryingmaximumCapacity in interface XReference<E>maximumCapacity in interface XReferencing<E>public final boolean replaceOne(E element, E replacement)
XReplacingBagreplaceOne in interface XReference<E>replaceOne in interface XReplacingBag<E>element - to replacereplacement - for the found elementtrue if element is found, false if notpublic final long replace(E element, E replacement)
replace in interface XReference<E>replace in interface XReplacingBag<E>public final long replaceAll(XGettingCollection<? extends E> elements, E replacement)
replaceAll in interface XReference<E>replaceAll in interface XReplacingBag<E>public final boolean replaceOne(Predicate<? super E> predicate, E substitute)
replaceOne in interface XReference<E>replaceOne in interface XReplacingBag<E>public final long replace(Predicate<? super E> predicate, E substitute)
replace in interface XReference<E>replace 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 boolean set(long index,
E element)
set in interface XReference<E>set in interface XSettingSequence<E>public final E setGet(long index, E element)
setGet in interface XReference<E>setGet in interface XSettingSequence<E>public final void setFirst(E element)
setFirst in interface XReference<E>setFirst in interface XSettingSequence<E>public final void setLast(E element)
setLast in interface XReference<E>setLast in interface XSettingSequence<E>public final Singleton<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 XOrderingEnum<E>shiftTo in interface XOrderingSequence<E>shiftTo in interface XReference<E>shiftTo in interface XSortableEnum<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 Singleton<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 XOrderingEnum<E>shiftTo in interface XOrderingSequence<E>shiftTo in interface XReference<E>shiftTo in interface XSortableEnum<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 Singleton<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 XOrderingEnum<E>shiftBy in interface XOrderingSequence<E>shiftBy in interface XReference<E>shiftBy in interface XSortableEnum<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 Singleton<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 XOrderingEnum<E>shiftBy in interface XOrderingSequence<E>shiftBy in interface XReference<E>shiftBy in interface XSortableEnum<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 void set(E element)
public final Singleton<E> fill(long offset, long length, E element)
XSettingListnull.fill in interface XReference<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 slots@SafeVarargs public final Singleton<E> setAll(long index, E... elements)
setAll in interface XReference<E>setAll in interface XSettingList<E>setAll in interface XSettingSequence<E>public final Singleton<E> set(long index, E[] elements, int offset, int length)
set in interface XReference<E>set in interface XSettingList<E>set in interface XSettingSequence<E>public final Singleton<E> set(long index, XGettingSequence<? extends E> elements, long offset, long length)
set in interface XReference<E>set in interface XSettingList<E>set in interface XSettingSequence<E>public final Singleton<E> swap(long indexA, long indexB)
swap in interface XOrderingEnum<E>swap in interface XOrderingSequence<E>swap in interface XReference<E>swap in interface XSettingList<E>swap in interface XSettingSequence<E>swap in interface XSortableEnum<E>swap in interface XSortableSequence<E>public final Singleton<E> swap(long indexA, long indexB, long length)
swap in interface XOrderingEnum<E>swap in interface XOrderingSequence<E>swap in interface XReference<E>swap in interface XSettingList<E>swap in interface XSettingSequence<E>swap in interface XSortableEnum<E>swap in interface XSortableSequence<E>public final Singleton<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 XOrderingEnum<E>reverse in interface XOrderingSequence<E>reverse in interface XReference<E>reverse in interface XSettingList<E>reverse in interface XSettingSequence<E>reverse in interface XSortableEnum<E>reverse in interface XSortableSequence<E>public final Singleton<E> sort(Comparator<? super E> comparator)
Sortablesort in interface Sortable<E>sort in interface XReference<E>sort in interface XSettingList<E>sort in interface XSettingSequence<E>sort in interface XSortableEnum<E>sort in interface XSortableSequence<E>comparator - to sort this collectionCopyright © 2022 MicroStream Software. All rights reserved.