Class EqHashTable.Values
- All Implemented Interfaces:
Iterable<V>,CapacityCarrying,ConsolidatableCollection,ExtendedBag<V>,ExtendedCollection<V>,ExtendedList<V>,ExtendedSequence<V>,OptimizableCollection,ReleasingCollection<V>,Sized,Truncateable,Sortable<V>,XBasicTable.Values<K,V>,XDecreasingList<V>,XDecreasingSequence<V>,XGettingBag<V>,XGettingCollection<V>,XGettingList<V>,XGettingMap.Satellite<K,V>,XGettingMap.Values<K,V>,XGettingSequence<V>,XGettingTable.Satellite<K,V>,XGettingTable.Values<K,V>,XIndexIterable<V>,XIterable<V>,XJoinable<V>,XMap.Satellite<K,V>,XMap.Values<K,V>,XOrderingSequence<V>,XProcessingBag<V>,XProcessingCollection<V>,XProcessingList<V>,XProcessingMap.Values<K,V>,XProcessingSequence<V>,XRemovingBag<V>,XRemovingCollection<V>,XRemovingList<V>,XRemovingSequence<V>,XReplacingBag<V>,XReplacingCollection<V>,XSettingList<V>,XSettingSequence<V>,XSortableSequence<V>,XTable.Values<K,V>,Processable<V>,Clearable,ComponentType,Copyable
- Enclosing class:
- EqHashTable<K,V>
public final class EqHashTable.Values extends Object implements XTable.Values<K,V>
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classEqHashTable.Values.OldValuesNested 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.XDecreasingList
XDecreasingList.Creator<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingBag
XGettingBag.Factory<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.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.XIterable
XIterable.Executor<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingBag
XProcessingBag.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingList
XProcessingList.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingSequence
XProcessingSequence.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XReplacingBag
XReplacingBag.Factory<E> -
Constructor Summary
Constructors Constructor Description Values() -
Method Summary
Modifier and Type Method Description booleanapplies(Predicate<? super V> predicate)Tests each element of the collection on the given predicate.Vat(long index)voidclear()Clears all elements from the collection while leaving the capacity as it is.longconsolidate()Consolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore.booleancontains(V value)Checks if the given element is contained in the collection.booleancontainsAll(XGettingCollection<? extends V> values)booleancontainsId(V value)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 V> predicate)XList<V>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 V>>
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 V>>
TcopyTo(T target)CallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection.longcount(V value)Count how many times this element matches another element in the collection using theEqualator.longcountBy(Predicate<? super V> predicate)Count how many matches are found using the given predicate on each element of the collection.<T extends Consumer<? super V>>
Tdistinct(T target)CallsConsumer.accept(Object)on the targetConsumerfor all the unique/distinct elements of this collection.<T extends Consumer<? super V>>
Tdistinct(T target, Equalator<? super V> equalator)CallsConsumer.accept(Object)on the targetConsumerfor all the unique/distinct elements of this collection.Equalator<? super V>equality()booleanequals(XGettingCollection<? extends V> samples, Equalator<? super V> equalator)booleanequalsContent(XGettingCollection<? extends V> samples, Equalator<? super V> equalator)Returnstrueif all elements of this list and the passed list are sequentially equal as defined by the passed equalator.<T extends Consumer<? super V>>
Texcept(XGettingCollection<? extends V> other, Equalator<? super V> 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).Vfetch()EqHashTable.Valuesfill(long offset, long length, V value)Fills all slots from the offset to the offset+length with the given element, regardless of whether or not a slot isnull.<T extends Consumer<? super V>>
TfilterTo(T target, Predicate<? super V> predicate)CallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection which testtrueon the given predicate.Vfirst()Gets first element or throwsIndexOutOfBoundsExceptionif the collection is empty.Vget()Gets one element from the collection.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.XImmutableList<V>immure()Provides an instance of an immutable collection type with equal behavior and data as this instance.longindexBy(Predicate<? super V> 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(V value)<T extends Consumer<? super V>>
Tintersect(XGettingCollection<? extends V> other, Equalator<? super V> 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 V> comparator)Tests if the collection is sorted according to the given comparator.<P extends Consumer<? super V>>
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 V>>
PiterateIndexed(P procedure)Iterates over elements with theIndexedAcceptorto use not only the element itself but also its coherent index.Iterator<V>iterator()<A> Ajoin(BiConsumer<? super V,? super A> joiner, A aggregate)Iterates over all elements of the collections and calls the joiner with each element and the aggregate.Vlast()Gets last element or throwsIndexOutOfBoundsExceptionif the collection is empty.longlastIndexBy(Predicate<? super V> 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(V value)ListIterator<V>listIterator()ListIterator<V>listIterator(long index)Vmax(Comparator<? super V> 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 V> comparator)Vmin(Comparator<? super V> comparator)longminIndex(Comparator<? super V> comparator)<C extends Consumer<? super V>>
CmoveSelection(C target, long... indices)<C extends Consumer<? super V>>
CmoveTo(C target, Predicate<? super V> predicate)booleannullAllowed()Defines if null-elements are allowed inside the collection or not.booleannullContained()longnullRemove()EqHashTable.Values.OldValuesold()longoptimize()Optimizes internal memory usage by rebuilding the storage to only occupy as much memory as needed to store the currently contained elements in terms of the collection's current memory usage configuration (e.g.EqHashTable<K,V>parent()Vpeek()Gets last element or null if the collection is empty.Vpick()Vpinch()Vpoll()Gets first element or null if the collection is empty.Vpop()<P extends Consumer<? super V>>
Pprocess(P procedure)SubListProcessor<V>range(long fromIndex, long toIndex)longremainingCapacity()Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.longremove(V value)longremoveAll(XGettingCollection<? extends V> values)VremoveAt(long index)longremoveBy(Predicate<? super V> predicate)longremoveDuplicates()longremoveDuplicates(Equalator<? super V> equalator)booleanremoveOne(V element)EqHashTable.ValuesremoveRange(long startIndex, long length)longremoveSelection(long[] indices)longreplace(Predicate<? super V> predicate, V substitute)longreplace(V value, V replacement)longreplaceAll(XGettingCollection<? extends V> values, V replacement)booleanreplaceOne(Predicate<? super V> predicate, V substitute)booleanreplaceOne(V value, V replacement)Replaces the first element that is equal to the given element with the replacement and then returns true.longretainAll(XGettingCollection<? extends V> values)Removing all elements except the ones contained in the given elements-collection.EqHashTable.ValuesretainRange(long startIndex, long length)Removing all elements but the ones from the offset (basically start index) to the offset+length (end index).Vretrieve(V value)VretrieveBy(Predicate<? super V> predicate)EqHashTable.Valuesreverse()Reverses the order of its own elements and returns itself.longscan(Predicate<? super V> predicate)Iterates through the collection and returns the index of the last element that the passedPredicateapplied to ("scanning").Vsearch(Predicate<? super V> predicate)Returns the first contained element matching the passed predicate.Vseek(V 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.EqHashTable.Valuesset(long offset, XGettingSequence<? extends V> values, long valuesOffset, long valuesLength)booleanset(long index, V value)EqHashTable.Valuesset(long offset, V[] src, int srcIndex, int srcLength)EqHashTable.ValuessetAll(long offset, V... values)voidsetFirst(V value)VsetGet(long index, V value)voidsetLast(V value)EqHashTable.ValuesshiftBy(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.EqHashTable.ValuesshiftBy(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.EqHashTable.ValuesshiftTo(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.EqHashTable.ValuesshiftTo(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.longsize()EqHashTable.Valuessort(Comparator<? super V> comparator)Sorts this collection according to the given comparator and returns itself.longsubstitute(Function<? super V,? extends V> mapper)longsubstitute(Predicate<? super V> predicate, Function<V,V> mapper)EqHashTable.Valuesswap(long indexA, long indexB)EqHashTable.Valuesswap(long indexA, long indexB, long length)Object[]toArray()Returns an array containing all of the elements in this collection.V[]toArray(Class<V> type)Returns a typed array containing all of the elements in this collection.EqHashTable.ValuestoReversed()Creates a newXGettingSequencewith the reversed order of elements.StringtoString()voidtruncate()Clears (and reinitializes if needed) this collection in the fastest possible way, i.e.<T extends Consumer<? super V>>
Tunion(XGettingCollection<? extends V> other, Equalator<? super V> equalator, T target)CallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection.ListView<V>view()Creates a view of this collection and returns it.SubListView<V>view(long fromIndex, long toIndex)Creates a sub-view of this collection and returns it.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface one.microstream.collections.types.XGettingCollection
equals, hashCode, intSize
-
Constructor Details
-
Values
public Values()
-
-
Method Details
-
equality
- Specified by:
equalityin interfaceXGettingCollection<V>
-
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 interfaceXBasicTable.Values<K,V>- Specified by:
copyin interfaceXDecreasingList<V>- Specified by:
copyin interfaceXDecreasingSequence<V>- Specified by:
copyin interfaceXGettingBag<V>- Specified by:
copyin interfaceXGettingCollection<V>- Specified by:
copyin interfaceXGettingList<V>- Specified by:
copyin interfaceXGettingSequence<V>- Specified by:
copyin interfaceXGettingTable.Values<K,V>- Specified by:
copyin interfaceXMap.Values<K,V>- Specified by:
copyin interfaceXProcessingBag<V>- Specified by:
copyin interfaceXProcessingList<V>- Specified by:
copyin interfaceXReplacingBag<V>- Specified by:
copyin interfaceXSettingList<V>- Specified by:
copyin interfaceXSettingSequence<V>- Specified by:
copyin interfaceXSortableSequence<V>- Specified by:
copyin interfaceXTable.Values<K,V>- 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 interfaceXGettingTable.Values<K,V>- Specified by:
iteratein interfaceXIterable<V>- Specified by:
iteratein interfaceXProcessingCollection<V>- 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<V>- Type Parameters:
P- type of procedure- Parameters:
procedure- which is executed when iterating- Returns:
- Given procedure
-
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 interfaceXDecreasingList<V>- Specified by:
toReversedin interfaceXDecreasingSequence<V>- Specified by:
toReversedin interfaceXGettingList<V>- Specified by:
toReversedin interfaceXGettingSequence<V>- Specified by:
toReversedin interfaceXProcessingList<V>- Specified by:
toReversedin interfaceXProcessingSequence<V>- Specified by:
toReversedin interfaceXSettingList<V>- Specified by:
toReversedin interfaceXSettingSequence<V>- Specified by:
toReversedin interfaceXSortableSequence<V>- Returns:
- New copy of the collection
-
containsSearched
- Specified by:
containsSearchedin interfaceXGettingCollection<V>
-
applies
Description copied from interface:XGettingCollectionTests each element of the collection on the given predicate.- Specified by:
appliesin interfaceXGettingCollection<V>- 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<V>- Parameters:
value- to be searched in the collection- Returns:
- Whether this collection contains the given element as specified by the
Equalator.
-
containsAll
- Specified by:
containsAllin interfaceXGettingCollection<V>- Parameters:
values- 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<V>- Parameters:
value- 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<V>- 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<V>- 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<V>- Parameters:
value- 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<V>- 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<V>- 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<V>- 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
-
equals
public final boolean equals(XGettingCollection<? extends V> samples, Equalator<? super V> equalator)- Specified by:
equalsin interfaceXGettingCollection<V>- 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 V> samples, Equalator<? super V> 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<V>- 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 V>> T except(XGettingCollection<? extends V> other, Equalator<? super V> 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<V>- 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<V>- Specified by:
hasVolatileElementsin interfaceXGettingCollection<V>- Returns:
trueif the collection contains volatile elements.
-
intersect
public final <T extends Consumer<? super V>> T intersect(XGettingCollection<? extends V> other, Equalator<? super V> 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<V>- 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() -
iterator
-
max
- Specified by:
maxin interfaceXGettingCollection<V>
-
min
- Specified by:
minin interfaceXGettingCollection<V>
-
nullAllowed
public final boolean nullAllowed()Description copied from interface:ExtendedCollectionDefines if null-elements are allowed inside the collection or not.- Specified by:
nullAllowedin interfaceExtendedCollection<V>- Returns:
trueif null is allowed inside the collection;falseif not
-
nullContained
public final boolean nullContained()- Specified by:
nullContainedin interfaceXGettingCollection<V>
-
old
- Specified by:
oldin interfaceXGettingCollection<V>- Specified by:
oldin interfaceXGettingList<V>
-
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<V>- 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<V>- Parameters:
predicate- defines which element is searched- Returns:
- Matching element
-
size
public final long size()- Specified by:
sizein interfaceSized- Specified by:
sizein interfaceXGettingCollection<V>
-
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- Returns:
- the maximum amount of elements this carrier instance can contain.
-
isFull
public final boolean isFull()Description copied from interface:CapacityCarryingReturns true if the current capacity cannot be increased any more.- Specified by:
isFullin interfaceCapacityCarrying
-
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
-
toString
-
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<V>- 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<V>- Returns:
- a typed array containing all of the elements in this collection
-
union
public final <T extends Consumer<? super V>> T union(XGettingCollection<? extends V> other, Equalator<? super V> 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<V>- 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
-
parent
- Specified by:
parentin interfaceXBasicTable.Values<K,V>- Specified by:
parentin interfaceXGettingMap.Satellite<K,V>- Specified by:
parentin interfaceXGettingTable.Satellite<K,V>- Specified by:
parentin interfaceXGettingTable.Values<K,V>- Specified by:
parentin interfaceXMap.Satellite<K,V>- Specified by:
parentin interfaceXTable.Values<K,V>
-
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 interfaceXGettingList<V>- Specified by:
viewin interfaceXGettingSequence<V>- Specified by:
viewin interfaceXProcessingSequence<V>- Parameters:
fromIndex- defines lower boundary for the view of the collection.toIndex- defines higher boundary for the view of the collection.- Returns:
- new read-only collection to view a range of elements in this collection
-
listIterator
- Specified by:
listIteratorin interfaceXGettingList<V>
-
listIterator
- Specified by:
listIteratorin interfaceXGettingList<V>
-
range
- Specified by:
rangein interfaceXDecreasingList<V>- Specified by:
rangein interfaceXDecreasingSequence<V>- Specified by:
rangein interfaceXGettingList<V>- Specified by:
rangein interfaceXGettingSequence<V>- Specified by:
rangein interfaceXSettingList<V>- Specified by:
rangein interfaceXSettingSequence<V>
-
immure
Description copied from interface:XGettingCollectionProvides an instance of an immutable collection type with equal behavior and data as this instance.If this instance already is of an immutable collection type, it returns itself.
- Specified by:
immurein interfaceXGettingBag<V>- Specified by:
immurein interfaceXGettingCollection<V>- Specified by:
immurein interfaceXGettingList<V>- Specified by:
immurein interfaceXGettingSequence<V>- Specified by:
immurein interfaceXProcessingBag<V>- Returns:
- an immutable copy of this collection instance.
-
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 interfaceXBasicTable.Values<K,V>- Specified by:
viewin interfaceXGettingBag<V>- Specified by:
viewin interfaceXGettingCollection<V>- Specified by:
viewin interfaceXGettingList<V>- Specified by:
viewin interfaceXGettingSequence<V>- Specified by:
viewin interfaceXProcessingBag<V>- Returns:
- new read-only collection to view this 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<V>- 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
-
at
- Specified by:
atin interfaceXGettingSequence<V>
-
get
Description copied from interface:XGettingCollectionGets one element from the collection. If the collection is not orderedXGettingSequence, then it is undefined which element is returned. If the collection is ordered, the element at index 0 is returned.- Specified by:
getin interfaceXGettingCollection<V>- Specified by:
getin interfaceXGettingSequence<V>- Returns:
- the first / any element.
- See Also:
XGettingSequence.at(long),XGettingSequence.first(),XGettingSequence.last()
-
first
Description copied from interface:XGettingSequenceGets first element or throwsIndexOutOfBoundsExceptionif the collection is empty.Is an alias for
XGettingSequence.get().- Specified by:
firstin interfaceXGettingSequence<V>- Returns:
- First element
-
last
Description copied from interface:XGettingSequenceGets last element or throwsIndexOutOfBoundsExceptionif the collection is empty.- Specified by:
lastin interfaceXGettingSequence<V>- Returns:
- Last element
-
poll
Description copied from interface:XGettingSequenceGets first element or null if the collection is empty.- Specified by:
pollin interfaceXGettingSequence<V>- Returns:
- First element or null
-
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<V>- Returns:
- Last element or null
-
indexOf
- Specified by:
indexOfin interfaceXGettingSequence<V>
-
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<V>- 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<V>- Parameters:
comparator- defines if elements are sorted- Returns:
- true if it sorted, false if not
-
lastIndexOf
- Specified by:
lastIndexOfin interfaceXGettingSequence<V>
-
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<V>- Parameters:
predicate- to define a valid element- Returns:
- the index of the last positively tested element.
-
maxIndex
- Specified by:
maxIndexin interfaceXGettingSequence<V>
-
minIndex
- Specified by:
minIndexin interfaceXGettingSequence<V>
-
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<V>- Parameters:
predicate- to define a valid element- Returns:
- the index of the last positively tested element.
-
moveSelection
- Specified by:
moveSelectionin interfaceXProcessingSequence<V>
-
removeAt
- Specified by:
removeAtin interfaceXProcessingSequence<V>
-
fetch
- Specified by:
fetchin interfaceXProcessingCollection<V>
-
pop
- Specified by:
popin interfaceXProcessingSequence<V>
-
pinch
- Specified by:
pinchin interfaceXProcessingCollection<V>
-
pick
- Specified by:
pickin interfaceXProcessingSequence<V>
-
retrieve
- Specified by:
retrievein interfaceXProcessingCollection<V>
-
retrieveBy
- Specified by:
retrieveByin interfaceXProcessingCollection<V>
-
removeOne
- Specified by:
removeOnein interfaceXRemovingCollection<V>
-
removeRange
- Specified by:
removeRangein interfaceXRemovingSequence<V>
-
retainRange
Description copied from interface:XRemovingSequenceRemoving all elements but the ones from the offset (basically start index) to the offset+length (end index).- Specified by:
retainRangein interfaceXRemovingSequence<V>- Parameters:
startIndex- is the index of the first element to retainlength- is the amount of elements to retain- Returns:
- this
-
removeSelection
public final long removeSelection(long[] indices)- Specified by:
removeSelectionin interfaceXRemovingSequence<V>
-
clear
public final void clear()Description copied from interface:XRemovingCollectionClears all elements from the collection while leaving the capacity as it is.- Specified by:
clearin interfaceClearable- Specified by:
clearin interfaceXRemovingCollection<V>
-
consolidate
public final long consolidate()Description copied from interface:ConsolidatableCollectionConsolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore. (e.g.WeakReferenceentries whose reference has been cleared).- Specified by:
consolidatein interfaceConsolidatableCollection- Specified by:
consolidatein interfaceXRemovingCollection<V>- Returns:
- the number of discarded entries.
-
moveTo
- Specified by:
moveToin interfaceXProcessingCollection<V>
-
nullRemove
public final long nullRemove()- Specified by:
nullRemovein interfaceXRemovingCollection<V>
-
optimize
public final long optimize()Description copied from interface:XRemovingCollectionOptimizes internal memory usage by rebuilding the storage to only occupy as much memory as needed to store the currently contained elements in terms of the collection's current memory usage configuration (e.g. hash density).If this is not possible or not needed in the concreate implementation, this method does nothing.
Note that this method can consume a considerable amount of time depending on the implementation and should only be called intentionally and accurately when reducing occupied memory is needed.
- Specified by:
optimizein interfaceOptimizableCollection- Specified by:
optimizein interfaceXRemovingCollection<V>- Returns:
- the amount of elements that can be added before the internal storage has to be adjusted.
-
process
- Specified by:
processin interfaceProcessable<V>
-
removeBy
- Specified by:
removeByin interfaceXProcessingCollection<V>
-
remove
- Specified by:
removein interfaceXRemovingCollection<V>
-
removeAll
- Specified by:
removeAllin interfaceXRemovingCollection<V>
-
removeDuplicates
public final long removeDuplicates()- Specified by:
removeDuplicatesin interfaceXRemovingCollection<V>
-
removeDuplicates
- Specified by:
removeDuplicatesin interfaceXProcessingCollection<V>
-
retainAll
Description copied from interface:XRemovingCollectionRemoving all elements except the ones contained in the given elements-collection.Basically intersect this collection with the given collection and only keeping the resulting elements.
- Specified by:
retainAllin interfaceXRemovingCollection<V>- Parameters:
values- to retain- Returns:
- Amount of deleted elements
-
truncate
public final void truncate()Description copied from interface:XRemovingCollectionClears (and reinitializes if needed) this collection in the fastest possible way, i.e. by allocating a new and empty internal storage of default capacity. The collection will be empty after calling this method.- Specified by:
truncatein interfaceTruncateable- Specified by:
truncatein interfaceXRemovingCollection<V>
-
fill
Description copied from interface:XSettingListFills all slots from the offset to the offset+length with the given element, regardless of whether or not a slot isnull.- Specified by:
fillin interfaceXDecreasingList<V>- Specified by:
fillin interfaceXSettingList<V>- Parameters:
offset- from the start of the collection (start index)length- of how many slots should be filledvalue- to use for filling of slots- Returns:
- this
-
replace
- Specified by:
replacein interfaceXReplacingBag<V>
-
replaceAll
- Specified by:
replaceAllin interfaceXReplacingBag<V>
-
substitute
- Specified by:
substitutein interfaceXReplacingCollection<V>
-
substitute
- Specified by:
substitutein interfaceXReplacingBag<V>
-
replaceOne
Description copied from interface:XReplacingBagReplaces the first element that is equal to the given element with the replacement and then returns true.- Specified by:
replaceOnein interfaceXReplacingBag<V>- Parameters:
value- to replacereplacement- for the found element- Returns:
trueif element is found,falseif not
-
reverse
Description copied from interface:XSortableSequenceReverses the order of its own elements and returns itself.Unlike the
XSortableSequence.toReversed()method, this method does not create a new collection, but changes the order of its own elements.- Specified by:
reversein interfaceXDecreasingList<V>- Specified by:
reversein interfaceXDecreasingSequence<V>- Specified by:
reversein interfaceXOrderingSequence<V>- Specified by:
reversein interfaceXSettingList<V>- Specified by:
reversein interfaceXSettingSequence<V>- Specified by:
reversein interfaceXSortableSequence<V>- Returns:
- this
-
set
- Specified by:
setin interfaceXSettingSequence<V>
-
setGet
- Specified by:
setGetin interfaceXSettingSequence<V>
-
setAll
- Specified by:
setAllin interfaceXDecreasingList<V>- Specified by:
setAllin interfaceXDecreasingSequence<V>- Specified by:
setAllin interfaceXSettingList<V>- Specified by:
setAllin interfaceXSettingSequence<V>
-
set
- Specified by:
setin interfaceXDecreasingList<V>- Specified by:
setin interfaceXDecreasingSequence<V>- Specified by:
setin interfaceXSettingList<V>- Specified by:
setin interfaceXSettingSequence<V>
-
set
public final EqHashTable.Values set(long offset, XGettingSequence<? extends V> values, long valuesOffset, long valuesLength)- Specified by:
setin interfaceXDecreasingList<V>- Specified by:
setin interfaceXDecreasingSequence<V>- Specified by:
setin interfaceXSettingList<V>- Specified by:
setin interfaceXSettingSequence<V>
-
setFirst
- Specified by:
setFirstin interfaceXSettingSequence<V>
-
setLast
- Specified by:
setLastin interfaceXSettingSequence<V>
-
sort
Description copied from interface:SortableSorts this collection according to the given comparator and returns itself.- Specified by:
sortin interfaceSortable<V>- Specified by:
sortin interfaceXDecreasingList<V>- Specified by:
sortin interfaceXDecreasingSequence<V>- Specified by:
sortin interfaceXSettingList<V>- Specified by:
sortin interfaceXSettingSequence<V>- Specified by:
sortin interfaceXSortableSequence<V>- Parameters:
comparator- to sort this collection- Returns:
- this
-
replace
- Specified by:
replacein interfaceXReplacingBag<V>
-
replaceOne
- Specified by:
replaceOnein interfaceXReplacingBag<V>
-
shiftTo
Description copied from interface:XOrderingSequenceMoves 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.Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededExceptionif sourceIndex or targetIndex are greater than the size of the sequence.- Specified by:
shiftToin interfaceXOrderingSequence<V>- Specified by:
shiftToin interfaceXSortableSequence<V>- Parameters:
sourceIndex- points to the source element; Index of the source elementtargetIndex- points to the target element; Index of the target element- Returns:
- this
-
shiftTo
Description copied from interface:XOrderingSequenceMoves 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.Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededExceptionif sourceIndex or targetIndex exceed the size of the sequence.- Specified by:
shiftToin interfaceXOrderingSequence<V>- Specified by:
shiftToin interfaceXSortableSequence<V>- Parameters:
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.- Returns:
- self
-
shiftBy
Description copied from interface:XOrderingSequenceMoves 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. ("to the right")Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededExceptionif sourceIndex or targetIndex (sourceIndex+distance) exceed the size of the sequence.- Specified by:
shiftByin interfaceXOrderingSequence<V>- Specified by:
shiftByin interfaceXSortableSequence<V>- Parameters:
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 22- Returns:
- self
-
shiftBy
Description copied from interface:XOrderingSequenceMoves 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. ("to the right")Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededExceptionif sourceIndex or targetIndex (sourceIndex+distance+length) exceed the size of the sequence.- Specified by:
shiftByin interfaceXOrderingSequence<V>- Specified by:
shiftByin interfaceXSortableSequence<V>- Parameters:
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.- Returns:
- self
-
swap
- Specified by:
swapin interfaceXDecreasingList<V>- Specified by:
swapin interfaceXDecreasingSequence<V>- Specified by:
swapin interfaceXOrderingSequence<V>- Specified by:
swapin interfaceXSettingList<V>- Specified by:
swapin interfaceXSettingSequence<V>- Specified by:
swapin interfaceXSortableSequence<V>
-
swap
- Specified by:
swapin interfaceXDecreasingList<V>- Specified by:
swapin interfaceXDecreasingSequence<V>- Specified by:
swapin interfaceXOrderingSequence<V>- Specified by:
swapin interfaceXSettingList<V>- Specified by:
swapin interfaceXSettingSequence<V>- Specified by:
swapin interfaceXSortableSequence<V>
-