Class ConstHashTable.Keys
- All Implemented Interfaces:
Iterable<K>
,CapacityCarrying
,ExtendedCollection<K>
,ExtendedSequence<K>
,HashCollection<K>
,Sized
,XGettingCollection<K>
,XGettingEnum<K>
,XGettingMap.Keys<K,V>
,XGettingMap.Satellite<K,V>
,XGettingSequence<K>
,XGettingSet<K>
,XGettingTable.Keys<K,V>
,XGettingTable.Satellite<K,V>
,XImmutableCollection<K>
,XImmutableEnum<K>
,XImmutableMap.Keys<K,V>
,XImmutableMap.Satellite<K,V>
,XImmutableSequence<K>
,XImmutableSet<K>
,XImmutableTable.Keys<K,V>
,XIndexIterable<K>
,XIterable<K>
,XJoinable<K>
,ThreadSafe
,HashImmutable
,ComponentType
,Copyable
,Immutable
- Enclosing class:
- ConstHashTable<K,V>
public final class ConstHashTable.Keys extends Object implements XImmutableTable.Keys<K,V>, HashCollection<K>
-
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.interfaces.HashCollection
HashCollection.Analysis<H>
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.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.XImmutableSet
XImmutableSet.Factory<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable
XIterable.Executor<E>
-
Field Summary
Fields inherited from interface one.microstream.collections.interfaces.HashCollection
DEFAULT_HASH_FACTOR, DEFAULT_HASH_LENGTH
-
Constructor Summary
Constructors Constructor Description Keys()
-
Method Summary
Modifier and Type Method Description HashCollection.Analysis<ConstHashTable.Keys>
analyze()
boolean
applies(Predicate<? super K> predicate)
Tests each element of the collection on the given predicate.K
at(long index)
boolean
contains(K element)
Checks if the given element is contained in the collection.boolean
containsAll(XGettingCollection<? extends K> elements)
boolean
containsId(K 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 aPredicate
implementation that checks for object identity.boolean
containsSearched(Predicate<? super K> predicate)
ConstHashTable.Keys
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 K>>
TcopySelection(T target, long... indices)
Iterates through all the elements of the given indices and calls theConsumer.accept(Object)
on the targetConsumer
.<C extends Consumer<? super K>>
CcopyTo(C target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection.long
count(K element)
Count how many times this element matches another element in the collection using theEqualator
.long
countBy(Predicate<? super K> predicate)
Count how many matches are found using the given predicate on each element of the collection.<C extends Consumer<? super K>>
Cdistinct(C target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the unique/distinct elements of this collection.<C extends Consumer<? super K>>
Cdistinct(C target, Equalator<? super K> equalator)
CallsConsumer.accept(Object)
on the targetConsumer
for all the unique/distinct elements of this collection.Equalator<? super K>
equality()
boolean
equals(XGettingCollection<? extends K> samples, Equalator<? super K> equalator)
boolean
equalsContent(XGettingCollection<? extends K> samples, Equalator<? super K> equalator)
Returnstrue
if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.<C extends Consumer<? super K>>
Cexcept(XGettingCollection<? extends K> other, Equalator<? super K> equalator, C target)
CallsConsumer.accept(Object)
on the targetConsumer
for each element of this collection that is not contained in the other collection (through the given equalator).<C extends Consumer<? super K>>
CfilterTo(C target, Predicate<? super K> predicate)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection which testtrue
on the given predicate.K
first()
Gets first element or throwsIndexOutOfBoundsException
if the collection is empty.K
get()
Gets one element from the collection.float
hashDensity()
int
hashDistributionRange()
HashEqualator<K>
hashEquality()
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.boolean
hasVolatileHashElements()
ConstHashTable.Keys
immure()
This method creates aEqConstHashEnum
instance containing all (currently existing) elements of thisConstHashTable
.
No matter which hashing logic this instance uses, the newEqConstHashEnum
instance always uses a STRONG EQUALATOR logic, using this instance's logic'sHashEqualator
.
This is necessary to ensure that theEqConstHashEnum
instance is really constant and does not (can not!) lose elements over time.
If aEqConstHashEnum
with volatile elements is needed (e.g.long
indexBy(Predicate<? super K> 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(K element)
<C extends Consumer<? super K>>
Cintersect(XGettingCollection<? extends K> other, Equalator<? super K> equalator, C target)
Tests equality between each element of the two lists and callsConsumer.accept(Object)
on the targetConsumer
for the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.boolean
isEmpty()
boolean
isFull()
Returns true if the current capacity cannot be increased any more.boolean
isSorted(Comparator<? super K> comparator)
Tests if the collection is sorted according to the given comparator.<P extends Consumer<? super K>>
Piterate(P procedure)
Executes the given procedure for each element of theXIterable
until all elements have been processed or the action throws an exception.<P extends IndexedAcceptor<? super K>>
PiterateIndexed(P procedure)
Iterates over elements with theIndexedAcceptor
to use not only the element itself but also its coherent index.Iterator<K>
iterator()
<A> A
join(BiConsumer<? super K,? super A> joiner, A aggregate)
Iterates over all elements of the collections and calls the joiner with each element and the aggregate.K
last()
Gets last element or throwsIndexOutOfBoundsException
if the collection is empty.long
lastIndexBy(Predicate<? super K> predicate)
Iterates backwards through the collection and returns the index of the last element that the passedPredicate
applies to immediately.
Stops iterating on the first element that the predicate applies to.long
lastIndexOf(K element)
K
max(Comparator<? super K> 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 K> comparator)
K
min(Comparator<? super K> comparator)
long
minIndex(Comparator<? super K> comparator)
boolean
nullAllowed()
Defines if null-elements are allowed inside the collection or not.boolean
nullContained()
OldCollection<K>
old()
ConstHashTable<K,V>
parent()
K
peek()
Gets last element or null if the collection is empty.K
poll()
Gets first element or null if the collection is empty.XEnum<K>
range(long lowIndex, long highIndex)
int
rehash()
Recalculates the hash value of all entries and reorginazes and optimizes the hash storage accordingly.long
remainingCapacity()
Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.long
scan(Predicate<? super K> predicate)
Iterates through the collection and returns the index of the last element that the passedPredicate
applied to ("scanning").K
search(Predicate<? super K> predicate)
Returns the first contained element matching the passed predicate.K
seek(K 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
setHashDensity(float hashDensity)
Sets the hash density (1/density) of this hashing collection if applicable.long
size()
Object[]
toArray()
Returns an array containing all of the elements in this collection.K[]
toArray(Class<K> type)
Returns a typed array containing all of the elements in this collection.ConstHashTable.Keys
toReversed()
Creates a newXGettingSequence
with the reversed order of elements.String
toString()
<C extends Consumer<? super K>>
Cunion(XGettingCollection<? extends K> other, Equalator<? super K> equalator, C target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection.XGettingEnum<K>
view()
Creates a view of this collection and returns it.XGettingEnum<K>
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, wait, wait, wait
Methods inherited from interface one.microstream.collections.types.XGettingCollection
equals, hashCode, intSize
-
Constructor Details
-
Keys
public Keys()
-
-
Method Details
-
hashDistributionRange
public final int hashDistributionRange()- Specified by:
hashDistributionRange
in interfaceHashCollection<K>
-
hasVolatileHashElements
public final boolean hasVolatileHashElements()- Specified by:
hasVolatileHashElements
in interfaceHashCollection<K>
-
setHashDensity
public final void setHashDensity(float hashDensity)Description copied from interface:HashCollection
Sets the hash density (1/density) of this hashing collection if applicable.If this procedure is not applicable for the hash collection (e.g. an immutable hash collection), calling this method has no effect.
- Specified by:
setHashDensity
in interfaceHashCollection<K>
- Parameters:
hashDensity
- the new hash density to be set.
-
analyze
- Specified by:
analyze
in interfaceHashCollection<K>
-
equality
- Specified by:
equality
in interfaceXGettingCollection<K>
-
copy
Description copied from interface:XGettingCollection
Creates 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:
copy
in interfaceCopyable
- Specified by:
copy
in interfaceXGettingCollection<K>
- Specified by:
copy
in interfaceXGettingEnum<K>
- Specified by:
copy
in interfaceXGettingSequence<K>
- Specified by:
copy
in interfaceXGettingSet<K>
- Specified by:
copy
in interfaceXImmutableCollection<K>
- Specified by:
copy
in interfaceXImmutableEnum<K>
- Specified by:
copy
in interfaceXImmutableSequence<K>
- Specified by:
copy
in interfaceXImmutableSet<K>
- Specified by:
copy
in interfaceXImmutableTable.Keys<K,V>
- Returns:
- a copy of this list
-
immure
This method creates aEqConstHashEnum
instance containing all (currently existing) elements of thisConstHashTable
.
No matter which hashing logic this instance uses, the newEqConstHashEnum
instance always uses a STRONG EQUALATOR logic, using this instance's logic'sHashEqualator
.
This is necessary to ensure that theEqConstHashEnum
instance is really constant and does not (can not!) lose elements over time.
If aEqConstHashEnum
with volatile elements is needed (e.g. as a "read-only weak set"), an appropriate custom behaviorEqConstHashEnum
instance can be created via the various copy constructors.- Specified by:
immure
in interfaceXGettingCollection<K>
- Specified by:
immure
in interfaceXGettingEnum<K>
- Specified by:
immure
in interfaceXGettingMap.Keys<K,V>
- Specified by:
immure
in interfaceXGettingSequence<K>
- Specified by:
immure
in interfaceXGettingSet<K>
- Specified by:
immure
in interfaceXImmutableCollection<K>
- Specified by:
immure
in interfaceXImmutableEnum<K>
- Specified by:
immure
in interfaceXImmutableSequence<K>
- Specified by:
immure
in interfaceXImmutableSet<K>
- Returns:
- a new
EqConstHashEnum
instance strongly referencing this set's current elements. - See Also:
XImmutableCollection.copy()
-
view
Description copied from interface:XGettingCollection
Creates 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:
view
in interfaceXGettingCollection<K>
- Specified by:
view
in interfaceXGettingEnum<K>
- Specified by:
view
in interfaceXGettingSequence<K>
- Returns:
- new read-only collection to view this collection
-
range
- Specified by:
range
in interfaceXGettingEnum<K>
- Specified by:
range
in interfaceXGettingSequence<K>
-
view
Description copied from interface:XGettingSequence
Creates 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:
view
in interfaceXGettingEnum<K>
- Specified by:
view
in interfaceXGettingSequence<K>
- 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
-
toArray
Description copied from interface:XGettingCollection
Returns 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:
toArray
in interfaceXGettingCollection<K>
- Returns:
- a typed array containing all of the elements in this collection
-
iterate
Description copied from interface:XIterable
Executes the given procedure for each element of theXIterable
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.
Should be identical toIterable.forEach(Consumer)
.- Specified by:
iterate
in interfaceXGettingEnum<K>
- Specified by:
iterate
in interfaceXGettingSet<K>
- Specified by:
iterate
in interfaceXIterable<K>
- Type Parameters:
P
- type of procedure- Parameters:
procedure
- The procedure to be performed for each element- Returns:
- Given procedure
-
join
Description copied from interface:XJoinable
Iterates over all elements of the collections and calls the joiner with each element and the aggregate. -
count
Description copied from interface:XGettingCollection
Count how many times this element matches another element in the collection using theEqualator
.- Specified by:
count
in interfaceXGettingCollection<K>
- Parameters:
element
- to count- Returns:
- Amount of matches
-
countBy
Description copied from interface:XGettingCollection
Count how many matches are found using the given predicate on each element of the collection.- Specified by:
countBy
in interfaceXGettingCollection<K>
- Parameters:
predicate
- defines which elements are counted and which are not- Returns:
- Amount of matches
-
seek
Description copied from interface:XGettingCollection
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. (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:
seek
in interfaceXGettingCollection<K>
- Parameters:
sample
- to seek in the collection- Returns:
- the first contained element matching the passed sample
-
search
Description copied from interface:XGettingCollection
Returns the first contained element matching the passed predicate.- Specified by:
search
in interfaceXGettingCollection<K>
- Parameters:
predicate
- defines which element is searched- Returns:
- Matching element
-
max
- Specified by:
max
in interfaceXGettingCollection<K>
-
min
- Specified by:
min
in interfaceXGettingCollection<K>
-
hasVolatileElements
public final boolean hasVolatileElements()Description copied from interface:ExtendedCollection
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. Examples areWeakReference
ofSoftReference
or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note thatWeakReference
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.- Specified by:
hasVolatileElements
in interfaceExtendedCollection<K>
- Specified by:
hasVolatileElements
in interfaceXGettingCollection<K>
- Returns:
true
if the collection contains volatile elements.
-
nullAllowed
public final boolean nullAllowed()Description copied from interface:ExtendedCollection
Defines if null-elements are allowed inside the collection or not.- Specified by:
nullAllowed
in interfaceExtendedCollection<K>
- Returns:
true
if null is allowed inside the collection;false
if not
-
containsSearched
- Specified by:
containsSearched
in interfaceXGettingCollection<K>
-
applies
Description copied from interface:XGettingCollection
Tests each element of the collection on the given predicate.- Specified by:
applies
in interfaceXGettingCollection<K>
- 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.
-
nullContained
public final boolean nullContained()- Specified by:
nullContained
in interfaceXGettingCollection<K>
-
containsId
Description copied from interface:XGettingCollection
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 aPredicate
implementation that checks for object identity. The only difference is a performance and usability advantage- Specified by:
containsId
in interfaceXGettingCollection<K>
- Parameters:
element
- the element to be searched in the collection by identity.- Returns:
- whether this collection contains exactly the given element.
-
contains
Description copied from interface:XGettingCollection
Checks if the given element is contained in the collection.
In contrast to theXGettingCollection.containsId(Object)
method, this method uses the internalEqualator
defined by the collection itself.- Specified by:
contains
in interfaceXGettingCollection<K>
- Parameters:
element
- to be searched in the collection- Returns:
- Whether this collection contains the given element as specified by the
Equalator
.
-
containsAll
- Specified by:
containsAll
in interfaceXGettingCollection<K>
- Parameters:
elements
- to be searched in the collection.- Returns:
- Whether this collection contains all given elements as specified by the
Equalator
.
-
equals
public final boolean equals(XGettingCollection<? extends K> samples, Equalator<? super K> equalator)- Specified by:
equals
in interfaceXGettingCollection<K>
- Parameters:
samples
- is the collection which is checked for equalityequalator
- is used to check the equality of the collections- Returns:
true
if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)
yieldstrue
-
equalsContent
public final boolean equalsContent(XGettingCollection<? extends K> samples, Equalator<? super K> equalator)Description copied from interface:XGettingCollection
Returnstrue
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 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:
equalsContent
in interfaceXGettingCollection<K>
- Parameters:
samples
- is the collection which is checked for equalityequalator
- the equalator to use to determine the equality of each element- Returns:
true
if this list is equal to the passed list,false
otherwise
-
intersect
public final <C extends Consumer<? super K>> C intersect(XGettingCollection<? extends K> other, Equalator<? super K> equalator, C target)Description copied from interface:XGettingCollection
Tests equality between each element of the two lists and callsConsumer.accept(Object)
on the targetConsumer
for the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.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 inintersection
containing 2 and 3.- Specified by:
intersect
in interfaceXGettingCollection<K>
- 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
-
except
public final <C extends Consumer<? super K>> C except(XGettingCollection<? extends K> other, Equalator<? super K> equalator, C target)Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
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 inexceptCollection
containing 1.- Specified by:
except
in interfaceXGettingCollection<K>
- Type Parameters:
C
- 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
-
union
public final <C extends Consumer<? super K>> C union(XGettingCollection<? extends K> other, Equalator<? super K> equalator, C target)Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
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 givenEqualator
)
Therefore it effectively creates a mathematical union between the two collections.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 inunion
containing 1, 2, 3 and 4.- Specified by:
union
in interfaceXGettingCollection<K>
- 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
-
copyTo
Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
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 incopiedCollection
containing 1, 2 and 3.- Specified by:
copyTo
in interfaceXGettingCollection<K>
- Parameters:
target
- on which theConsumer.accept(Object)
is called for all elements of this collection.- Returns:
- Given target
-
filterTo
Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection which testtrue
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 infilteredCollection
containing 2.- Specified by:
filterTo
in interfaceXGettingCollection<K>
- Parameters:
target
- on which theConsumer.accept(Object)
is called for elements that testtrue
.predicate
- on which to test all elements.- Returns:
- Given target
-
distinct
Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for 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
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 indistinctCollection
containing 1, 2 and 3.- Specified by:
distinct
in interfaceXGettingCollection<K>
- Parameters:
target
- on which theConsumer.accept(Object)
is called for every distinct element of this collection.- Returns:
- Given target
-
distinct
Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for 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
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 indistinctCollection
containing 1, 2 and 3.- Specified by:
distinct
in interfaceXGettingCollection<K>
- 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
-
maximumCapacity
public final long maximumCapacity()Description copied from interface:CapacityCarrying
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.Integer.MAX_VALUE
)- Specified by:
maximumCapacity
in interfaceCapacityCarrying
- Returns:
- the maximum amount of elements this carrier instance can contain.
-
isFull
public final boolean isFull()Description copied from interface:CapacityCarrying
Returns true if the current capacity cannot be increased any more.- Specified by:
isFull
in interfaceCapacityCarrying
-
remainingCapacity
public final long remainingCapacity()Description copied from interface:CapacityCarrying
Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.- Specified by:
remainingCapacity
in interfaceCapacityCarrying
-
toReversed
Description copied from interface:XGettingSequence
Creates a newXGettingSequence
with the reversed order of elements.This method creates a new collection and does not change the existing collection.
- Specified by:
toReversed
in interfaceXGettingEnum<K>
- Specified by:
toReversed
in interfaceXGettingSequence<K>
- Specified by:
toReversed
in interfaceXImmutableEnum<K>
- Specified by:
toReversed
in interfaceXImmutableSequence<K>
- Returns:
- New copy of the collection
-
copySelection
Description copied from interface:XGettingSequence
Iterates through all the elements of the given indices and calls theConsumer.accept(Object)
on the targetConsumer
.- Specified by:
copySelection
in interfaceXGettingSequence<K>
- 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
-
iterateIndexed
Description copied from interface:XIndexIterable
Iterates over elements with theIndexedAcceptor
to use not only the element itself but also its coherent index.- Specified by:
iterateIndexed
in interfaceXIndexIterable<K>
- Type Parameters:
P
- type of procedure- Parameters:
procedure
- which is executed when iterating- Returns:
- Given procedure
-
at
- Specified by:
at
in interfaceXGettingSequence<K>
-
get
Description copied from interface:XGettingCollection
Gets 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:
get
in interfaceXGettingCollection<K>
- Specified by:
get
in interfaceXGettingSequence<K>
- Returns:
- the first / any element.
- See Also:
XGettingSequence.at(long)
,XGettingSequence.first()
,XGettingSequence.last()
-
first
Description copied from interface:XGettingSequence
Gets first element or throwsIndexOutOfBoundsException
if the collection is empty.Is an alias for
XGettingSequence.get()
.- Specified by:
first
in interfaceXGettingSequence<K>
- Returns:
- First element
-
last
Description copied from interface:XGettingSequence
Gets last element or throwsIndexOutOfBoundsException
if the collection is empty.- Specified by:
last
in interfaceXGettingSequence<K>
- Returns:
- Last element
-
poll
Description copied from interface:XGettingSequence
Gets first element or null if the collection is empty.- Specified by:
poll
in interfaceXGettingSequence<K>
- Returns:
- First element or null
-
peek
Description copied from interface:XGettingSequence
Gets last element or null if the collection is empty.
This behaves like peeking on a stack without pop.- Specified by:
peek
in interfaceXGettingSequence<K>
- Returns:
- Last element or null
-
indexOf
- Specified by:
indexOf
in interfaceXGettingSequence<K>
-
indexBy
Description copied from interface:XGettingSequence
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.Basically the opposite of
XGettingSequence.lastIndexBy(Predicate)
- Specified by:
indexBy
in interfaceXGettingSequence<K>
- Parameters:
predicate
- to define a valid element- Returns:
- The index of the first positively tested element.
-
isSorted
Description copied from interface:XGettingSequence
Tests if the collection is sorted according to the given comparator.- Specified by:
isSorted
in interfaceXGettingSequence<K>
- Parameters:
comparator
- defines if elements are sorted- Returns:
- true if it sorted, false if not
-
lastIndexOf
- Specified by:
lastIndexOf
in interfaceXGettingSequence<K>
-
lastIndexBy
Description copied from interface:XGettingSequence
Iterates backwards through the collection and returns the index of the last element that the passedPredicate
applies 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)
, sincescan
iterates through all elements.- Specified by:
lastIndexBy
in interfaceXGettingSequence<K>
- Parameters:
predicate
- to define a valid element- Returns:
- the index of the last positively tested element.
-
maxIndex
- Specified by:
maxIndex
in interfaceXGettingSequence<K>
-
minIndex
- Specified by:
minIndex
in interfaceXGettingSequence<K>
-
scan
Description copied from interface:XGettingSequence
Iterates through the collection and returns the index of the last element that the passedPredicate
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)
andXGettingSequence.lastIndexBy(Predicate)
).Iteration can be safely canceled with a
ThrowBreak
(X.BREAK
)- Specified by:
scan
in interfaceXGettingSequence<K>
- Parameters:
predicate
- to define a valid element- Returns:
- the index of the last positively tested element.
-
isEmpty
public final boolean isEmpty() -
iterator
-
size
public final long size()- Specified by:
size
in interfaceHashCollection<K>
- Specified by:
size
in interfaceSized
- Specified by:
size
in interfaceXGettingCollection<K>
-
rehash
public final int rehash()Description copied from interface:HashCollection
Recalculates the hash value of all entries and reorginazes and optimizes the hash storage accordingly. This method is meant for cases where a hash collection has to collect its elements before proper hash values can be derived for them or where hash mutable elements can change their hash-relevant state after having been added (and hashed) in a hash collection. Note that depending on the hash-relevant state of elements and their changing of it, it can be possible that some elements oust others, thus decreasing the collection's size. This behavior depends on the type of the elements and the used hash logic and cannot be compensated by a general purpose collection implementation.- Specified by:
rehash
in interfaceHashCollection<K>
- Returns:
- the new size of the collection which might be lower than before the call.
-
toString
-
toArray
Description copied from interface:XGettingCollection
Returns 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:
toArray
in interfaceXGettingCollection<K>
- Returns:
- an array containing all of the elements in this collection
-
old
- Specified by:
old
in interfaceXGettingCollection<K>
-
parent
- Specified by:
parent
in interfaceXGettingMap.Satellite<K,V>
- Specified by:
parent
in interfaceXGettingTable.Keys<K,V>
- Specified by:
parent
in interfaceXGettingTable.Satellite<K,V>
- Specified by:
parent
in interfaceXImmutableMap.Satellite<K,V>
- Specified by:
parent
in interfaceXImmutableTable.Keys<K,V>
-
hashEquality
- Specified by:
hashEquality
in interfaceHashCollection<K>
-
hashDensity
public final float hashDensity()- Specified by:
hashDensity
in interfaceHashCollection<K>
-