Class Constant<E>
- Type Parameters:
E-
- All Implemented Interfaces:
Iterable<E>,CapacityCarrying,ExtendedBag<E>,ExtendedCollection<E>,ExtendedList<E>,ExtendedSequence<E>,Sized,XGettingBag<E>,XGettingCollection<E>,XGettingEnum<E>,XGettingList<E>,XGettingSequence<E>,XGettingSet<E>,XImmutableBag<E>,XImmutableCollection<E>,XImmutableEnum<E>,XImmutableList<E>,XImmutableSequence<E>,XImmutableSet<E>,XIndexIterable<E>,XIterable<E>,XJoinable<E>,XReferencing<E>,ThreadSafe,HashImmutable,Referencing<E>,Copyable,Immutable
- Direct Known Subclasses:
LinkingReferencing.Default
public class Constant<E> extends Object implements XImmutableList<E>, XImmutableEnum<E>, XReferencing<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. .
- See Also:
Singleton
-
Nested Class Summary
Nested classes/interfaces inherited from interface one.microstream.collections.interfaces.ExtendedCollection
ExtendedCollection.Creator<E,C extends ExtendedCollection<E>>Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingCollection
XGettingCollection.Creator<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingEnum
XGettingEnum.Creator<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingList
XGettingList.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingSequence
XGettingSequence.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingSet
XGettingSet.Creator<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XImmutableEnum
XImmutableEnum.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XImmutableList
XImmutableList.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable
XIterable.Executor<E> -
Constructor Summary
-
Method Summary
Modifier and Type Method Description booleanapplies(Predicate<? super E> predicate)Tests each element of the collection on the given predicate.Eat(long index)booleancontains(E element)Checks if the given element is contained in the collection.booleancontainsAll(XGettingCollection<? extends E> elements)booleancontainsId(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 asXGettingCollection.containsSearched(Predicate)with aPredicateimplementation that checks for object identity.booleancontainsSearched(Predicate<? super E> predicate)Constant<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.<T extends Consumer<? super E>>
TcopySelection(T target, long... indices)Iterates through all the elements of the given indices and calls theConsumer.accept(Object)on the targetConsumer.<T extends Consumer<? super E>>
TcopyTo(T target)CallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection.longcount(E element)Count how many times this element matches another element in the collection using theEqualator.longcountBy(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>>
Tdistinct(T target)CallsConsumer.accept(Object)on the targetConsumerfor all the unique/distinct elements of this collection.<T extends Consumer<? super E>>
Tdistinct(T target, Equalator<? super E> equalator)CallsConsumer.accept(Object)on the targetConsumerfor all the unique/distinct elements of this collection.Equalator<? super E>equality()booleanequals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)booleanequalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Returnstrueif all elements of this list and the passed list are sequentially equal as defined by the passed equalator.<T extends Consumer<? super E>>
Texcept(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)CallsConsumer.accept(Object)on the targetConsumerfor each element of this collection that is not contained in the other collection (through the given equalator).<T extends Consumer<? super E>>
TfilterTo(T target, Predicate<? super E> predicate)CallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection which testtrueon the given predicate.Efirst()Gets first element or throwsIndexOutOfBoundsExceptionif the collection is empty.Eget()Convenience alias forfirst().booleanhasVolatileElements()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()Always returns the already immutable collection instance itselflongindexBy(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.longindexOf(E element)<T extends Consumer<? super E>>
Tintersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)Tests equality between each element of the two lists and callsConsumer.accept(Object)on the targetConsumerfor the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.booleanisEmpty()booleanisFull()Returns true if the current capacity cannot be increased any more.booleanisSorted(Comparator<? super E> comparator)Tests if the collection is sorted according to the given comparator.<P extends Consumer<? super E>>
Piterate(P procedure)Executes the given procedure for each element of theXIterableuntil all elements have been processed or the action throws an exception.<P extends IndexedAcceptor<? super E>>
PiterateIndexed(P procedure)Iterates over elements with theIndexedAcceptorto use not only the element itself but also its coherent index.Iterator<E>iterator()<A> Ajoin(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.Elast()Gets last element or throwsIndexOutOfBoundsExceptionif the collection is empty.longlastIndexBy(Predicate<? super E> predicate)Iterates backwards through the collection and returns the index of the last element that the passedPredicateapplies to immediately.
Stops iterating on the first element that the predicate applies to.longlastIndexOf(E element)ListIterator<E>listIterator()ListIterator<E>listIterator(long index)Emax(Comparator<? super E> comparator)longmaximumCapacity()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.longmaxIndex(Comparator<? super E> comparator)Emin(Comparator<? super E> comparator)longminIndex(Comparator<? super E> comparator)booleannullAllowed()Defines if null-elements are allowed inside the collection or not.booleannullContained()one.microstream.collections.Constant.OldConstantold()Epeek()Gets last element or null if the collection is empty.Epoll()Gets first element or null if the collection is empty.Constant<E>range(long fromIndex, long toIndex)longremainingCapacity()Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.longscan(Predicate<? super E> predicate)Iterates through the collection and returns the index of the last element that the passedPredicateapplied to ("scanning").Esearch(Predicate<? super E> predicate)Returns the first contained element matching the passed predicate.Eseek(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.longsize()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.Constant<E>toReversed()Creates a newXGettingSequencewith the reversed order of elements.<T extends Consumer<? super E>>
Tunion(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)CallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection.Constant<E>view()Creates a view of this collection and returns it.Constant<E>view(long lowIndex, long highIndex)Creates a sub-view of this collection and returns it.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface one.microstream.collections.types.XGettingCollection
equals, hashCode, intSize
-
Constructor Details
-
Method Details
-
get
Convenience alias forfirst().- Specified by:
getin interfaceReferencing<E>- Specified by:
getin interfaceXGettingCollection<E>- Specified by:
getin interfaceXGettingSequence<E>- Specified by:
getin interfaceXReferencing<E>- Returns:
- the contained element.
- See Also:
XGettingSequence.at(long),XGettingSequence.first(),XGettingSequence.last()
-
copy
Description copied from interface:XGettingCollectionCreates a true copy of this collection which references the same elements as this collection does at the time the method is called. The elements themselves are NOT copied (no deep copying).
The type of the returned set is the same as of this list if possible.- Specified by:
copyin interfaceCopyable- Specified by:
copyin interfaceXGettingBag<E>- Specified by:
copyin interfaceXGettingCollection<E>- Specified by:
copyin interfaceXGettingEnum<E>- Specified by:
copyin interfaceXGettingList<E>- Specified by:
copyin interfaceXGettingSequence<E>- Specified by:
copyin interfaceXGettingSet<E>- Specified by:
copyin interfaceXImmutableBag<E>- Specified by:
copyin interfaceXImmutableCollection<E>- Specified by:
copyin interfaceXImmutableEnum<E>- Specified by:
copyin interfaceXImmutableList<E>- Specified by:
copyin interfaceXImmutableSequence<E>- Specified by:
copyin interfaceXImmutableSet<E>- Specified by:
copyin interfaceXReferencing<E>- Returns:
- a copy of this list
-
iterate
Description copied from interface:XIterableExecutes the given procedure for each element of theXIterableuntil 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.
Should be identical toIterable.forEach(Consumer).- Specified by:
iteratein interfaceXGettingEnum<E>- Specified by:
iteratein interfaceXGettingSet<E>- Specified by:
iteratein interfaceXIterable<E>- Type Parameters:
P- type of procedure- Parameters:
procedure- The procedure to be performed for each element- Returns:
- Given procedure
-
join
Description copied from interface:XJoinableIterates over all elements of the collections and calls the joiner with each element and the aggregate. -
iterateIndexed
Description copied from interface:XIndexIterableIterates over elements with theIndexedAcceptorto use not only the element itself but also its coherent index.- Specified by:
iterateIndexedin interfaceXIndexIterable<E>- Type Parameters:
P- type of procedure- Parameters:
procedure- which is executed when iterating- Returns:
- Given procedure
-
immure
Description copied from interface:XImmutableListAlways returns the already immutable collection instance itselfFor spawning a copy of the collection instance, see
XImmutableCollection.copy()- Specified by:
immurein interfaceXGettingBag<E>- Specified by:
immurein interfaceXGettingCollection<E>- Specified by:
immurein interfaceXGettingEnum<E>- Specified by:
immurein interfaceXGettingList<E>- Specified by:
immurein interfaceXGettingSequence<E>- Specified by:
immurein interfaceXGettingSet<E>- Specified by:
immurein interfaceXImmutableBag<E>- Specified by:
immurein interfaceXImmutableCollection<E>- Specified by:
immurein interfaceXImmutableEnum<E>- Specified by:
immurein interfaceXImmutableList<E>- Specified by:
immurein interfaceXImmutableSequence<E>- Specified by:
immurein interfaceXImmutableSet<E>- Specified by:
immurein interfaceXReferencing<E>- Returns:
- a reference to the instance itself.
- See Also:
XImmutableCollection.copy()
-
listIterator
- Specified by:
listIteratorin interfaceXGettingList<E>- Specified by:
listIteratorin interfaceXReferencing<E>
-
listIterator
- Specified by:
listIteratorin interfaceXGettingList<E>- Specified by:
listIteratorin interfaceXReferencing<E>
-
old
public final one.microstream.collections.Constant.OldConstant old()- Specified by:
oldin interfaceXGettingCollection<E>- Specified by:
oldin interfaceXGettingList<E>- Specified by:
oldin interfaceXReferencing<E>
-
range
- Specified by:
rangein interfaceXGettingEnum<E>- Specified by:
rangein interfaceXGettingList<E>- Specified by:
rangein interfaceXGettingSequence<E>- Specified by:
rangein interfaceXImmutableList<E>- Specified by:
rangein interfaceXReferencing<E>
-
toReversed
Description copied from interface:XGettingSequenceCreates a newXGettingSequencewith the reversed order of elements.This method creates a new collection and does not change the existing collection.
- Specified by:
toReversedin interfaceXGettingEnum<E>- Specified by:
toReversedin interfaceXGettingList<E>- Specified by:
toReversedin interfaceXGettingSequence<E>- Specified by:
toReversedin interfaceXImmutableEnum<E>- Specified by:
toReversedin interfaceXImmutableList<E>- Specified by:
toReversedin interfaceXImmutableSequence<E>- Specified by:
toReversedin interfaceXReferencing<E>- Returns:
- New copy of the collection
-
copySelection
Description copied from interface:XGettingSequenceIterates through all the elements of the given indices and calls theConsumer.accept(Object)on the targetConsumer.- Specified by:
copySelectionin interfaceXGettingSequence<E>- Specified by:
copySelectionin interfaceXReferencing<E>- Type Parameters:
T- type of the target- Parameters:
target- on which theConsumer.accept(Object)is calledindices- of the elements which are copied- Returns:
- Given target
-
first
Description copied from interface:XGettingSequenceGets first element or throwsIndexOutOfBoundsExceptionif the collection is empty.Is an alias for
XGettingSequence.get().- Specified by:
firstin interfaceXGettingSequence<E>- Specified by:
firstin interfaceXReferencing<E>- Returns:
- First element
-
at
- Specified by:
atin interfaceXGettingSequence<E>- Specified by:
atin interfaceXReferencing<E>
-
indexOf
- Specified by:
indexOfin interfaceXGettingSequence<E>- Specified by:
indexOfin interfaceXReferencing<E>
-
indexBy
Description copied from interface:XGettingSequenceIterates 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.Basically the opposite of
XGettingSequence.lastIndexBy(Predicate)- Specified by:
indexByin interfaceXGettingSequence<E>- Specified by:
indexByin interfaceXReferencing<E>- Parameters:
predicate- to define a valid element- Returns:
- The index of the first positively tested element.
-
isSorted
Description copied from interface:XGettingSequenceTests if the collection is sorted according to the given comparator.- Specified by:
isSortedin interfaceXGettingSequence<E>- Specified by:
isSortedin interfaceXReferencing<E>- Parameters:
comparator- defines if elements are sorted- Returns:
- true if it sorted, false if not
-
last
Description copied from interface:XGettingSequenceGets last element or throwsIndexOutOfBoundsExceptionif the collection is empty.- Specified by:
lastin interfaceXGettingSequence<E>- Specified by:
lastin interfaceXReferencing<E>- Returns:
- Last element
-
lastIndexOf
- Specified by:
lastIndexOfin interfaceXGettingSequence<E>- Specified by:
lastIndexOfin interfaceXReferencing<E>
-
lastIndexBy
Description copied from interface:XGettingSequenceIterates backwards through the collection and returns the index of the last element that the passedPredicateapplies to immediately.
Stops iterating on the first element that the predicate applies to.Basically the opposite of
XGettingSequence.indexBy(Predicate).
Similar but not the same asXGettingSequence.scan(Predicate), sincescaniterates through all elements.- Specified by:
lastIndexByin interfaceXGettingSequence<E>- Specified by:
lastIndexByin interfaceXReferencing<E>- Parameters:
predicate- to define a valid element- Returns:
- the index of the last positively tested element.
-
maxIndex
- Specified by:
maxIndexin interfaceXGettingSequence<E>- Specified by:
maxIndexin interfaceXReferencing<E>
-
minIndex
- Specified by:
minIndexin interfaceXGettingSequence<E>- Specified by:
minIndexin interfaceXReferencing<E>
-
peek
Description copied from interface:XGettingSequenceGets last element or null if the collection is empty.
This behaves like peeking on a stack without pop.- Specified by:
peekin interfaceXGettingSequence<E>- Specified by:
peekin interfaceXReferencing<E>- Returns:
- Last element or null
-
poll
Description copied from interface:XGettingSequenceGets first element or null if the collection is empty.- Specified by:
pollin interfaceXGettingSequence<E>- Specified by:
pollin interfaceXReferencing<E>- Returns:
- First element or null
-
scan
Description copied from interface:XGettingSequenceIterates through the collection and returns the index of the last element that the passedPredicateapplied to ("scanning").In order to find the last element, this method must iterate over all elements of the collection (opposed to
XGettingSequence.indexBy(Predicate)andXGettingSequence.lastIndexBy(Predicate)).Iteration can be safely canceled with a
ThrowBreak(X.BREAK)- Specified by:
scanin interfaceXGettingSequence<E>- Specified by:
scanin interfaceXReferencing<E>- Parameters:
predicate- to define a valid element- Returns:
- the index of the last positively tested element.
-
view
Description copied from interface:XGettingCollectionCreates a view of this collection and returns it. It is a read-only collection, which wraps around this collection and only allows read methods.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.- Specified by:
viewin interfaceXGettingBag<E>- Specified by:
viewin interfaceXGettingCollection<E>- Specified by:
viewin interfaceXGettingEnum<E>- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>- Specified by:
viewin interfaceXImmutableList<E>- Specified by:
viewin interfaceXReferencing<E>- Returns:
- new read-only collection to view this collection
-
view
Description copied from interface:XGettingSequenceCreates a sub-view of this collection and returns it. It is a read-only collection, which wraps around this collection and only allows read methods.
The view is limited to a range from the lowIndex to the highIndex.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.- Specified by:
viewin interfaceXGettingEnum<E>- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>- Specified by:
viewin interfaceXImmutableList<E>- Specified by:
viewin interfaceXReferencing<E>- Parameters:
lowIndex- defines lower boundary for the view of the collection.highIndex- defines higher boundary for the view of the collection.- Returns:
- new read-only collection to view a range of elements in this collection
-
containsSearched
- Specified by:
containsSearchedin interfaceXGettingCollection<E>- Specified by:
containsSearchedin interfaceXReferencing<E>
-
applies
Description copied from interface:XGettingCollectionTests each element of the collection on the given predicate.- Specified by:
appliesin interfaceXGettingCollection<E>- Specified by:
appliesin interfaceXReferencing<E>- Parameters:
predicate- that's tested on each element.- Returns:
- If all elements test successfully, true is returned. Otherwise (if at least one test has failed), false is returned.
-
contains
Description copied from interface:XGettingCollectionChecks if the given element is contained in the collection.
In contrast to theXGettingCollection.containsId(Object)method, this method uses the internalEqualatordefined by the collection itself.- Specified by:
containsin interfaceXGettingCollection<E>- Specified by:
containsin interfaceXReferencing<E>- Parameters:
element- to be searched in the collection- Returns:
- Whether this collection contains the given element as specified by the
Equalator.
-
containsAll
- Specified by:
containsAllin interfaceXGettingCollection<E>- Specified by:
containsAllin interfaceXReferencing<E>- Parameters:
elements- to be searched in the collection.- Returns:
- Whether this collection contains all given elements as specified by the
Equalator.
-
containsId
Description copied from interface:XGettingCollectionSpecial 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 asXGettingCollection.containsSearched(Predicate)with aPredicateimplementation that checks for object identity. The only difference is a performance and usability advantage- Specified by:
containsIdin interfaceXGettingCollection<E>- Specified by:
containsIdin interfaceXReferencing<E>- Parameters:
element- the element to be searched in the collection by identity.- Returns:
- whether this collection contains exactly the given element.
-
copyTo
Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection.Since all MicroStream Collections implement the
Consumerinterface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3);
BulkList<Integer> copiedCollection = collection1.copyTo(BulkList.New());
Results incopiedCollectioncontaining 1, 2 and 3.- Specified by:
copyToin interfaceXGettingCollection<E>- Specified by:
copyToin interfaceXReferencing<E>- Parameters:
target- on which theConsumer.accept(Object)is called for all elements of this collection.- Returns:
- Given target
-
filterTo
Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection which testtrueon the given predicate.Since all MicroStream Collections implement the
Consumerinterface, 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 infilteredCollectioncontaining 2.- Specified by:
filterToin interfaceXGettingCollection<E>- Specified by:
filterToin interfaceXReferencing<E>- Parameters:
target- on which theConsumer.accept(Object)is called for elements that testtrue.predicate- on which to test all elements.- Returns:
- Given target
-
count
Description copied from interface:XGettingCollectionCount how many times this element matches another element in the collection using theEqualator.- Specified by:
countin interfaceXGettingCollection<E>- Specified by:
countin interfaceXReferencing<E>- Parameters:
element- to count- Returns:
- Amount of matches
-
countBy
Description copied from interface:XGettingCollectionCount how many matches are found using the given predicate on each element of the collection.- Specified by:
countByin interfaceXGettingCollection<E>- Specified by:
countByin interfaceXReferencing<E>- Parameters:
predicate- defines which elements are counted and which are not- Returns:
- Amount of matches
-
distinct
Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor all the unique/distinct elements of this collection. This means the elements are not equal to each other.
Uniqueness is defined by the collections internalEqualator.Since all MicroStream Collections implement the
Consumerinterface, 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 indistinctCollectioncontaining 1, 2 and 3.- Specified by:
distinctin interfaceXGettingCollection<E>- Specified by:
distinctin interfaceXReferencing<E>- Parameters:
target- on which theConsumer.accept(Object)is called for every distinct element of this collection.- Returns:
- Given target
-
distinct
Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor all the unique/distinct elements of this collection. This means the elements are not equal to each other.
Uniqueness is defined by the givenEqualator.Since all MicroStream Collections implement the
Consumerinterface, 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 indistinctCollectioncontaining 1, 2 and 3.- Specified by:
distinctin interfaceXGettingCollection<E>- Specified by:
distinctin interfaceXReferencing<E>- Parameters:
target- on which theConsumer.accept(Object)is called for every distinct element of this collection.equalator- defines what distinct means (which elements are equal to one another)- Returns:
- Given target
-
equality
- Specified by:
equalityin interfaceXGettingCollection<E>- Specified by:
equalityin interfaceXReferencing<E>
-
equals
public final boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)- Specified by:
equalsin interfaceXGettingCollection<E>- Specified by:
equalsin interfaceXReferencing<E>- Parameters:
samples- is the collection which is checked for equalityequalator- is used to check the equality of the collections- Returns:
trueif the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)yieldstrue
-
equalsContent
public final boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Description copied from interface:XGettingCollectionReturnstrueif 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 inCollection). The core problem of comparing collections that have no defined order is that they aren't really reliably comparable to any other collection.- Specified by:
equalsContentin interfaceXGettingCollection<E>- Specified by:
equalsContentin interfaceXReferencing<E>- Parameters:
samples- is the collection which is checked for equalityequalator- the equalator to use to determine the equality of each element- Returns:
trueif this list is equal to the passed list,falseotherwise
-
except
public final <T extends Consumer<? super E>> T except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor each element of this collection that is not contained in the other collection (through the given equalator).Since all MicroStream Collections implement the
Consumerinterface, 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 inexceptCollectioncontaining 1.- Specified by:
exceptin interfaceXGettingCollection<E>- Specified by:
exceptin interfaceXReferencing<E>- Type Parameters:
T- type of the target- Parameters:
other- collection whose elements are excluded from the target.equalator- which is used for the equal-tests.target- on which theConsumer.accept(Object)is called for elements not contained in the other collection.- Returns:
- Given target
-
hasVolatileElements
public final boolean hasVolatileElements()Description copied from interface:ExtendedCollectionTells 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. Examples areWeakReferenceofSoftReferenceor implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note thatWeakReferenceinstances 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.- Specified by:
hasVolatileElementsin interfaceExtendedCollection<E>- Specified by:
hasVolatileElementsin interfaceXGettingCollection<E>- Specified by:
hasVolatileElementsin interfaceXReferencing<E>- Returns:
trueif the collection contains volatile elements.
-
intersect
public final <T extends Consumer<? super E>> T intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)Description copied from interface:XGettingCollectionTests equality between each element of the two lists and callsConsumer.accept(Object)on the targetConsumerfor the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.Since all MicroStream Collections implement the
Consumerinterface, 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 inintersectioncontaining 2 and 3.- Specified by:
intersectin interfaceXGettingCollection<E>- Specified by:
intersectin interfaceXReferencing<E>- Parameters:
other- collection to intersect with.equalator- which is used for the equal-tests.target- on which theConsumer.accept(Object)is called for equal elements.- Returns:
- Given target
-
isEmpty
public final boolean isEmpty()- Specified by:
isEmptyin interfaceSized- Specified by:
isEmptyin interfaceXReferencing<E>
-
iterator
- Specified by:
iteratorin interfaceIterable<E>- Specified by:
iteratorin interfaceXGettingCollection<E>- Specified by:
iteratorin interfaceXReferencing<E>
-
max
- Specified by:
maxin interfaceXGettingCollection<E>- Specified by:
maxin interfaceXReferencing<E>
-
min
- Specified by:
minin interfaceXGettingCollection<E>- Specified by:
minin interfaceXReferencing<E>
-
nullContained
public final boolean nullContained()- Specified by:
nullContainedin interfaceXGettingCollection<E>- Specified by:
nullContainedin interfaceXReferencing<E>
-
seek
Description copied from interface:XGettingCollectionReturns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained. (For collections using referential equality, this method is basically just a variation ofXGettingCollection.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)- Specified by:
seekin interfaceXGettingCollection<E>- Specified by:
seekin interfaceXReferencing<E>- Parameters:
sample- to seek in the collection- Returns:
- the first contained element matching the passed sample
-
search
Description copied from interface:XGettingCollectionReturns the first contained element matching the passed predicate.- Specified by:
searchin interfaceXGettingCollection<E>- Specified by:
searchin interfaceXReferencing<E>- Parameters:
predicate- defines which element is searched- Returns:
- Matching element
-
size
public final long size()- Specified by:
sizein interfaceSized- Specified by:
sizein interfaceXGettingCollection<E>- Specified by:
sizein interfaceXReferencing<E>
-
toArray
Description copied from interface:XGettingCollectionReturns an array containing all of the elements in this collection.The 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.
- Specified by:
toArrayin interfaceXGettingCollection<E>- Specified by:
toArrayin interfaceXReferencing<E>- Returns:
- an array containing all of the elements in this collection
-
toArray
Description copied from interface:XGettingCollectionReturns a typed array containing all of the elements in this collection.The 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.
- Specified by:
toArrayin interfaceXGettingCollection<E>- Specified by:
toArrayin interfaceXReferencing<E>- Returns:
- a typed array containing all of the elements in this collection
-
union
public final <T extends Consumer<? super E>> T union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor 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 givenEqualator)
Therefore it effectively creates a mathematical union between the two collections.Since all MicroStream Collections implement the
Consumerinterface, 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 inunioncontaining 1, 2, 3 and 4.- Specified by:
unionin interfaceXGettingCollection<E>- Specified by:
unionin interfaceXReferencing<E>- Parameters:
other- collection to build a union with.equalator- which is used for the equal-tests.target- on which theConsumer.accept(Object)is called for all unified elements.- Returns:
- Given target
-
nullAllowed
public final boolean nullAllowed()Description copied from interface:ExtendedCollectionDefines if null-elements are allowed inside the collection or not.- Specified by:
nullAllowedin interfaceExtendedCollection<E>- Specified by:
nullAllowedin interfaceXReferencing<E>- Returns:
trueif null is allowed inside the collection;falseif not
-
remainingCapacity
public final long remainingCapacity()Description copied from interface:CapacityCarryingReturns the amount of elements this carrier instance can collect before reaching its maximimum capacity.- Specified by:
remainingCapacityin interfaceCapacityCarrying- Specified by:
remainingCapacityin interfaceXReferencing<E>
-
isFull
public final boolean isFull()Description copied from interface:CapacityCarryingReturns true if the current capacity cannot be increased any more.- Specified by:
isFullin interfaceCapacityCarrying- Specified by:
isFullin interfaceXReferencing<E>
-
maximumCapacity
public final long maximumCapacity()Description copied from interface:CapacityCarryingReturns 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.Integer.MAX_VALUE)- Specified by:
maximumCapacityin interfaceCapacityCarrying- Specified by:
maximumCapacityin interfaceXReferencing<E>- Returns:
- the maximum amount of elements this carrier instance can contain.
-