Package one.microstream.collections
Class EqConstHashTable.Keys
- java.lang.Object
-
- one.microstream.collections.EqConstHashTable.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:
- EqConstHashTable<K,V>
public final class EqConstHashTable.Keys extends Object implements XImmutableTable.Keys<K,V>, HashCollection<K>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface one.microstream.typing.Copyable
Copyable.Static
-
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<EqConstHashTable.Keys>
analyze()
boolean
applies(Predicate<? super K> predicate)
K
at(long index)
boolean
contains(K element)
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)
EqConstHashTable.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)
<C extends Consumer<? super K>>
CcopyTo(C target)
long
count(K element)
long
countBy(Predicate<? super K> predicate)
<C extends Consumer<? super K>>
Cdistinct(C target)
<C extends Consumer<? super K>>
Cdistinct(C target, Equalator<? super K> equalator)
Equalator<? super K>
equality()
boolean
equals(XGettingCollection<? extends K> samples, Equalator<? super K> equalator)
Returnstrue
if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)
yieldstrue
.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)
<C extends Consumer<? super K>>
CfilterTo(C target, Predicate<? super K> predicate)
K
first()
K
get()
Gets one element from the collection.float
hashDensity()
int
hashDistributionRange()
HashEqualator<? super 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()
EqConstHashTable.Keys
immure()
This method creates aEqConstHashEnum
instance containing all (currently existing) elements of thisEqConstHashTable
.
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)
long
indexOf(K element)
<C extends Consumer<? super K>>
Cintersect(XGettingCollection<? extends K> other, Equalator<? super K> equalator, C target)
boolean
isEmpty()
boolean
isFull()
Returns true if the current capacity cannot be increased any more.boolean
isSorted(Comparator<? super K> comparator)
<P extends Consumer<? super K>>
Piterate(P procedure)
<P extends IndexedAcceptor<? super K>>
PiterateIndexed(P procedure)
Iterator<K>
iterator()
<A> A
join(BiConsumer<? super K,? super A> joiner, A aggregate)
K
last()
long
lastIndexBy(Predicate<? super K> predicate)
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()
boolean
nullContained()
OldCollection<K>
old()
EqConstHashTable<K,V>
parent()
K
peek()
K
poll()
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)
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()
K[]
toArray(Class<K> type)
EqConstHashTable.Keys
toReversed()
String
toString()
<C extends Consumer<? super K>>
Cunion(XGettingCollection<? extends K> other, Equalator<? super K> equalator, C target)
XGettingEnum<K>
view()
XGettingEnum<K>
view(long lowIndex, long highIndex)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface one.microstream.hashing.HashImmutable
equals, hashCode
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Methods inherited from interface one.microstream.collections.types.XGettingCollection
equals, hashCode, intSize
-
Methods inherited from interface one.microstream.collections.types.XGettingSequence
hasIndex
-
-
-
-
Method Detail
-
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
public final HashCollection.Analysis<EqConstHashTable.Keys> analyze()
- Specified by:
analyze
in interfaceHashCollection<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.
-
equality
public final Equalator<? super K> equality()
- Specified by:
equality
in interfaceXGettingCollection<K>
-
copy
public final EqConstHashTable.Keys 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
public final EqConstHashTable.Keys immure()
This method creates aEqConstHashEnum
instance containing all (currently existing) elements of thisEqConstHashTable
.
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
public final XGettingEnum<K> view()
- Specified by:
view
in interfaceXGettingCollection<K>
- Specified by:
view
in interfaceXGettingEnum<K>
- Specified by:
view
in interfaceXGettingSequence<K>
-
range
public final XEnum<K> range(long lowIndex, long highIndex)
- Specified by:
range
in interfaceXGettingEnum<K>
- Specified by:
range
in interfaceXGettingSequence<K>
-
view
public final XGettingEnum<K> view(long lowIndex, long highIndex)
- Specified by:
view
in interfaceXGettingEnum<K>
- Specified by:
view
in interfaceXGettingSequence<K>
-
toArray
public final K[] toArray(Class<K> type)
- Specified by:
toArray
in interfaceXGettingCollection<K>
-
iterate
public final <P extends Consumer<? super K>> P iterate(P procedure)
- Specified by:
iterate
in interfaceXGettingEnum<K>
- Specified by:
iterate
in interfaceXGettingSet<K>
- Specified by:
iterate
in interfaceXIterable<K>
-
join
public final <A> A join(BiConsumer<? super K,? super A> joiner, A aggregate)
-
count
public final long count(K element)
- Specified by:
count
in interfaceXGettingCollection<K>
-
countBy
public final long countBy(Predicate<? super K> predicate)
- Specified by:
countBy
in interfaceXGettingCollection<K>
-
seek
public final K seek(K sample)
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>
-
search
public final K search(Predicate<? super K> predicate)
- Specified by:
search
in interfaceXGettingCollection<K>
-
max
public final K max(Comparator<? super K> comparator)
- Specified by:
max
in interfaceXGettingCollection<K>
-
min
public final K min(Comparator<? super K> comparator)
- Specified by:
min
in interfaceXGettingCollection<K>
-
hasVolatileElements
public final boolean hasVolatileElements()
Description copied from interface:XGettingCollection
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()
- Specified by:
nullAllowed
in interfaceExtendedCollection<K>
-
containsSearched
public final boolean containsSearched(Predicate<? super K> predicate)
- Specified by:
containsSearched
in interfaceXGettingCollection<K>
-
applies
public final boolean applies(Predicate<? super K> predicate)
- Specified by:
applies
in interfaceXGettingCollection<K>
-
nullContained
public final boolean nullContained()
- Specified by:
nullContained
in interfaceXGettingCollection<K>
-
containsId
public final boolean containsId(K element)
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 exactely the given element.
-
contains
public final boolean contains(K element)
- Specified by:
contains
in interfaceXGettingCollection<K>
-
containsAll
public final boolean containsAll(XGettingCollection<? extends K> elements)
- Specified by:
containsAll
in interfaceXGettingCollection<K>
-
equals
public final boolean equals(XGettingCollection<? extends K> samples, Equalator<? super K> equalator)
Description copied from interface:XGettingCollection
Returnstrue
if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)
yieldstrue
.- Specified by:
equals
in interfaceXGettingCollection<K>
-
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>
equalator
- 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)
- Specified by:
intersect
in interfaceXGettingCollection<K>
-
except
public final <C extends Consumer<? super K>> C except(XGettingCollection<? extends K> other, Equalator<? super K> equalator, C target)
- Specified by:
except
in interfaceXGettingCollection<K>
-
union
public final <C extends Consumer<? super K>> C union(XGettingCollection<? extends K> other, Equalator<? super K> equalator, C target)
- Specified by:
union
in interfaceXGettingCollection<K>
-
copyTo
public final <C extends Consumer<? super K>> C copyTo(C target)
- Specified by:
copyTo
in interfaceXGettingCollection<K>
-
filterTo
public final <C extends Consumer<? super K>> C filterTo(C target, Predicate<? super K> predicate)
- Specified by:
filterTo
in interfaceXGettingCollection<K>
-
distinct
public final <C extends Consumer<? super K>> C distinct(C target)
- Specified by:
distinct
in interfaceXGettingCollection<K>
-
distinct
public final <C extends Consumer<? super K>> C distinct(C target, Equalator<? super K> equalator)
- Specified by:
distinct
in interfaceXGettingCollection<K>
-
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
public final EqConstHashTable.Keys toReversed()
- Specified by:
toReversed
in interfaceXGettingEnum<K>
- Specified by:
toReversed
in interfaceXGettingSequence<K>
- Specified by:
toReversed
in interfaceXImmutableEnum<K>
- Specified by:
toReversed
in interfaceXImmutableSequence<K>
-
copySelection
public final <T extends Consumer<? super K>> T copySelection(T target, long... indices)
- Specified by:
copySelection
in interfaceXGettingSequence<K>
-
iterateIndexed
public final <P extends IndexedAcceptor<? super K>> P iterateIndexed(P procedure)
- Specified by:
iterateIndexed
in interfaceXIndexIterable<K>
-
at
public final K at(long index)
- Specified by:
at
in interfaceXGettingSequence<K>
-
get
public final 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
public final K first()
- Specified by:
first
in interfaceXGettingSequence<K>
-
last
public final K last()
- Specified by:
last
in interfaceXGettingSequence<K>
-
poll
public final K poll()
- Specified by:
poll
in interfaceXGettingSequence<K>
-
peek
public final K peek()
- Specified by:
peek
in interfaceXGettingSequence<K>
-
indexOf
public final long indexOf(K element)
- Specified by:
indexOf
in interfaceXGettingSequence<K>
-
indexBy
public final long indexBy(Predicate<? super K> predicate)
- Specified by:
indexBy
in interfaceXGettingSequence<K>
-
isSorted
public final boolean isSorted(Comparator<? super K> comparator)
- Specified by:
isSorted
in interfaceXGettingSequence<K>
-
lastIndexOf
public final long lastIndexOf(K element)
- Specified by:
lastIndexOf
in interfaceXGettingSequence<K>
-
lastIndexBy
public final long lastIndexBy(Predicate<? super K> predicate)
- Specified by:
lastIndexBy
in interfaceXGettingSequence<K>
-
maxIndex
public final long maxIndex(Comparator<? super K> comparator)
- Specified by:
maxIndex
in interfaceXGettingSequence<K>
-
minIndex
public final long minIndex(Comparator<? super K> comparator)
- Specified by:
minIndex
in interfaceXGettingSequence<K>
-
scan
public final long scan(Predicate<? super K> predicate)
Description copied from interface:XGettingSequence
Iterates through the collection and returns the index of the last element that the passedPredicate
applied to ("scanning").- Specified by:
scan
in interfaceXGettingSequence<K>
- Returns:
- the index of the last positively tested element.
-
size
public final long size()
- Specified by:
size
in interfaceHashCollection<K>
- Specified by:
size
in interfaceSized
- Specified by:
size
in interfaceXGettingCollection<K>
-
toArray
public final Object[] toArray()
- Specified by:
toArray
in interfaceXGettingCollection<K>
-
old
public final OldCollection<K> old()
- Specified by:
old
in interfaceXGettingCollection<K>
-
parent
public final EqConstHashTable<K,V> 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
public final HashEqualator<? super K> hashEquality()
- Specified by:
hashEquality
in interfaceHashCollection<K>
-
hashDensity
public final float hashDensity()
- Specified by:
hashDensity
in interfaceHashCollection<K>
-
-