java.lang.Object
- one.microstream.collections.EqHashTable.Keys

All Implemented Interfaces:

Iterable<K>, Consumer<K>, CapacityCarrying, CapacityExtendable, ConsolidatableCollection, ExtendedCollection<K>, ExtendedSequence<K>, HashCollection<K>, OptimizableCollection, ReleasingCollection<K>, Sized, Truncateable, Sortable<K>, SortableProcedure<K>, XAddGetCollection<K>, XAddGetSet<K>, XAddingCollection<K>, XAddingEnum<K>, XAddingSequence<K>, XAddingSet<K>, XBasicEnum<K>, XBasicSequence<K>, XBasicTable.Keys<K,V>, XCollection<K>, XDecreasingEnum<K>, XDecreasingSequence<K>, XEnum<K>, XExpandingEnum<K>, XExpandingSequence<K>, XExtendingEnum<K>, XExtendingSequence<K>, XGettingCollection<K>, XGettingEnum<K>, XGettingMap.Keys<K,V>, XGettingMap.Satellite<K,V>, XGettingSequence<K>, XGettingSet<K>, XGettingTable.Keys<K,V>, XGettingTable.Satellite<K,V>, XIncreasingEnum<K>, XIncreasingSequence<K>, XIndexIterable<K>, XInputtingEnum<K>, XInputtingSequence<K>, XInsertingEnum<K>, XInsertingSequence<K>, XIterable<K>, XJoinable<K>, XMap.Keys<K,V>, XMap.Satellite<K,V>, XOrderingEnum<K>, XOrderingSequence<K>, XPrependingEnum<K>, XPrependingSequence<K>, XPreputtingEnum<K>, XPreputtingSequence<K>, XProcessingCollection<K>, XProcessingEnum<K>, XProcessingMap.Keys<K,V>, XProcessingSequence<K>, XProcessingSet<K>, XPutGetCollection<K>, XPutGetEnum<K>, XPutGetSequence<K>, XPutGetSet<K>, XPuttingCollection<K>, XPuttingEnum<K>, XPuttingSequence<K>, XPuttingSet<K>, XRemovingCollection<K>, XRemovingEnum<K>, XRemovingSequence<K>, XRemovingSet<K>, XReplacingCollection<K>, XSequence<K>, XSet<K>, XSettingEnum<K>, XSettingSequence<K>, XSortableEnum<K>, XSortableSequence<K>, XTable.Keys<K,V>, Processable<K>, Clearable, ComponentType, Copyable

Enclosing class:

EqHashTable<K,V>
```
public final class EqHashTable.Keys
extends Object
implements XTable.Keys<K,V>, HashCollection<K>
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class EqHashTable.Keys.OldKeys
- 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.XAddGetCollection
  XAddGetCollection.Creator<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XAddingSet
  XAddingSet.Creator<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XBasicEnum
  XBasicEnum.Creator<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XBasicSequence
  XBasicSequence.Factory<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XEnum
  XEnum.Creator<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingCollection
  XGettingCollection.Creator<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingEnum
  XGettingEnum.Creator<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.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.XIncreasingEnum
  XIncreasingEnum.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.XProcessingSequence
  XProcessingSequence.Factory<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingSet
  XProcessingSet.Factory<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XPutGetCollection
  XPutGetCollection.Creator<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XPutGetSequence
  XPutGetSequence.Factory<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XPutGetSet
  XPutGetSet.Factory<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XPuttingSet
  XPuttingSet.Creator<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XRemovingEnum
  XRemovingEnum.Factory<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XSet
  XSet.Factory<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
`void`	`accept(K element)`
`boolean`	`add(K element)`
`EqHashTable.Keys`	`addAll(K... elements)`
`EqHashTable.Keys`	`addAll(K[] elements, int srcIndex, int srcLength)`
`EqHashTable.Keys`	`addAll(XGettingCollection<? extends K> elements)`
`K`	`addGet(K element)`
`HashCollection.Analysis<EqHashTable.Keys>`	`analyze()`
`boolean`	`applies(Predicate<? super K> predicate)`
`K`	`at(long index)`
`void`	`clear()`	Cuts all references to existing entries, effectively clearing the set.
`long`	`consolidate()`	Consolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore.
`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 as `XGettingCollection.containsSearched(Predicate)` with a `Predicate` implementation that checks for object identity.
`boolean`	`containsSearched(Predicate<? super K> predicate)`
`EqHashTable.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>> T`	`copySelection(T target, long... indices)`
`<C extends Consumer<? super K>> C`	`copyTo(C target)`
`long`	`count(K element)`
`long`	`countBy(Predicate<? super K> predicate)`
`long`	`currentCapacity()`	Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.
`K`	`deduplicate(K element)`
`<C extends Consumer<? super K>> C`	`distinct(C target)`
`<C extends Consumer<? super K>> C`	`distinct(C target, Equalator<? super K> equalator)`
`EqHashTable.Keys`	`ensureCapacity(long minimalCapacity)`
`EqHashTable.Keys`	`ensureFreeCapacity(long requiredFreeCapacity)`	Ensures that the next minimalFreeCapacity elements can be actually added in a fast way, meaning for example no internal storage rebuild will be necessary.
`Equalator<? super K>`	`equality()`
`boolean`	`equals(XGettingCollection<? extends K> samples, Equalator<? super K> equalator)`	Returns `true` if the passed collection is of the same type as this collection and`this.equalsContent(list, equalator)` yields `true`.
`boolean`	`equalsContent(XGettingCollection<? extends K> samples, Equalator<? super K> equalator)`	Returns `true` if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.
`<C extends Consumer<? super K>> C`	`except(XGettingCollection<? extends K> other, Equalator<? super K> equalator, C target)`
`K`	`fetch()`
`<C extends Consumer<? super K>> C`	`filterTo(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()`
`EqConstHashEnum<K>`	`immure()`	This method creates a `EqConstHashEnum` instance containing all (currently existing) elements of this `EqConstHashEnum`. No matter which hashing logic this instance uses, the new `EqConstHashEnum` instance always uses a STRONG EQUALATOR logic, using this instance's logic's `HashEqualator`. This is necessary to ensure that the `EqConstHashEnum` instance is really constant and does not (can not!) lose elements over time. If a `EqConstHashEnum` with volatile elements is needed (e.g.
`long`	`indexBy(Predicate<? super K> predicate)`
`long`	`indexOf(K element)`
`boolean`	`input(long index, K element)`
`long`	`inputAll(long index, K... elements)`
`long`	`inputAll(long index, K[] elements, int offset, int length)`
`long`	`inputAll(long index, XGettingCollection<? extends K> elements)`
`boolean`	`insert(long index, K element)`
`long`	`insertAll(long index, K... elements)`
`long`	`insertAll(long index, K[] elements, int offset, int length)`
`long`	`insertAll(long index, XGettingCollection<? extends K> elements)`
`<C extends Consumer<? super K>> C`	`intersect(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>> P`	`iterate(P procedure)`
`<P extends IndexedAcceptor<? super K>> P`	`iterateIndexed(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)`
`<C extends Consumer<? super K>> C`	`moveSelection(C target, long... indices)`
`<C extends Consumer<? super K>> C`	`moveTo(C target, Predicate<? super K> predicate)`
`boolean`	`nullAdd()`
`boolean`	`nullAllowed()`
`boolean`	`nullContained()`
`boolean`	`nullInput(long index)`
`boolean`	`nullInsert(long index)`
`boolean`	`nullPrepend()`
`boolean`	`nullPreput()`
`boolean`	`nullPut()`
`long`	`nullRemove()`
`EqHashTable.Keys.OldKeys`	`old()`
`long`	`optimize()`	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()`
`K`	`peek()`
`K`	`pick()`
`K`	`pinch()`
`K`	`poll()`
`K`	`pop()`
`boolean`	`prepend(K element)`
`EqHashTable.Keys`	`prependAll(K... elements)`
`EqHashTable.Keys`	`prependAll(K[] elements, int srcStartIndex, int srcLength)`
`EqHashTable.Keys`	`prependAll(XGettingCollection<? extends K> elements)`
`boolean`	`preput(K element)`
`EqHashTable.Keys`	`preputAll(K... elements)`
`EqHashTable.Keys`	`preputAll(K[] elements, int offset, int length)`
`EqHashTable.Keys`	`preputAll(XGettingCollection<? extends K> elements)`
`<P extends Consumer<? super K>> P`	`process(P procedure)`
`boolean`	`put(K element)`
`EqHashTable.Keys`	`putAll(K... elements)`
`EqHashTable.Keys`	`putAll(K[] elements, int srcIndex, int srcLength)`
`EqHashTable.Keys`	`putAll(XGettingCollection<? extends K> elements)`
`K`	`putGet(K element)`
`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`	`remove(K element)`
`long`	`removeAll(XGettingCollection<? extends K> elements)`
`K`	`removeAt(long index)`
`long`	`removeBy(Predicate<? super K> predicate)`
`long`	`removeDuplicates()`
`long`	`removeDuplicates(Equalator<? super K> equalator)`
`boolean`	`removeOne(K element)`
`EqHashTable.Keys`	`removeRange(long startIndex, long length)`
`long`	`removeSelection(long[] indices)`
`K`	`replace(K element)`
`long`	`retainAll(XGettingCollection<? extends K> elements)`
`EqHashTable.Keys`	`retainRange(long startIndex, long length)`
`K`	`retrieve(K element)`
`K`	`retrieveBy(Predicate<? super K> predicate)`
`EqHashTable.Keys`	`reverse()`
`long`	`scan(Predicate<? super K> predicate)`	Iterates through the collection and returns the index of the last element that the passed `Predicate`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.
`boolean`	`set(long index, K element)`
`EqHashTable.Keys`	`set(long index, K[] elements, int offset, int length)`
`EqHashTable.Keys`	`set(long index, XGettingSequence<? extends K> elements, long offset, long length)`
`EqHashTable.Keys`	`setAll(long index, K... elements)`
`void`	`setFirst(K element)`
`K`	`setGet(long index, K element)`
`void`	`setHashDensity(float hashDensity)`	Sets the hash density (1/density) of this hashing collection if applicable.
`void`	`setLast(K element)`
`EqHashTable.Keys`	`shiftBy(long sourceIndex, long distance)`
`EqHashTable.Keys`	`shiftBy(long sourceIndex, long distance, long length)`
`EqHashTable.Keys`	`shiftTo(long sourceIndex, long targetIndex)`
`EqHashTable.Keys`	`shiftTo(long sourceIndex, long targetIndex, long length)`
`long`	`size()`
`EqHashTable.Keys`	`sort(Comparator<? super K> comparator)`
`long`	`substitute(Function<? super K,? extends K> mapper)`
`EqHashTable.Keys`	`swap(long indexA, long indexB)`
`EqHashTable.Keys`	`swap(long indexA, long indexB, long length)`
`Object[]`	`toArray()`
`K[]`	`toArray(Class<K> type)`
`EqHashTable.Keys`	`toReversed()`
`String`	`toString()`
`void`	`truncate()`	Allocates a new internal storage with default size.
`<C extends Consumer<? super K>> C`	`union(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.collections.interfaces.CapacityCarrying
remainingCapacity

Methods inherited from interface one.microstream.collections.interfaces.CapacityExtendable
currentFreeCapacity

Methods inherited from interface java.util.function.Consumer
andThen

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface one.microstream.collections.types.XCollection
collector

Methods inherited from interface one.microstream.collections.types.XGettingCollection
equals, hashCode, intSize

Methods inherited from interface one.microstream.collections.types.XGettingSequence
hasIndex

- Constructor Detail
  - Keys
```
public Keys()
```
- Method Detail
  - hashDistributionRange
```
public final int hashDistributionRange()
```
    Specified by:
    
    hashDistributionRange in interface HashCollection<K>
  - hasVolatileHashElements
```
public final boolean hasVolatileHashElements()
```
    Specified by:
    
    hasVolatileHashElements in interface HashCollection<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 interface HashCollection<K>
    
    Parameters:
    
    hashDensity - the new hash density to be set.
  - analyze
```
public final HashCollection.Analysis<EqHashTable.Keys> analyze()
```
    Specified by:
    
    analyze in interface HashCollection<K>
  - equality
```
public final Equalator<? super K> equality()
```
    Specified by:
    
    equality in interface XGettingCollection<K>
  - copy
```
public final EqHashTable.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 interface Copyable
    
    Specified by:
    
    copy in interface XAddGetCollection<K>
    
    Specified by:
    
    copy in interface XAddGetSet<K>
    
    Specified by:
    
    copy in interface XBasicEnum<K>
    
    Specified by:
    
    copy in interface XBasicSequence<K>
    
    Specified by:
    
    copy in interface XBasicTable.Keys<K,V>
    
    Specified by:
    
    copy in interface XCollection<K>
    
    Specified by:
    
    copy in interface XDecreasingEnum<K>
    
    Specified by:
    
    copy in interface XDecreasingSequence<K>
    
    Specified by:
    
    copy in interface XEnum<K>
    
    Specified by:
    
    copy in interface XGettingCollection<K>
    
    Specified by:
    
    copy in interface XGettingEnum<K>
    
    Specified by:
    
    copy in interface XGettingSequence<K>
    
    Specified by:
    
    copy in interface XGettingSet<K>
    
    Specified by:
    
    copy in interface XIncreasingEnum<K>
    
    Specified by:
    
    copy in interface XIncreasingSequence<K>
    
    Specified by:
    
    copy in interface XProcessingEnum<K>
    
    Specified by:
    
    copy in interface XProcessingSet<K>
    
    Specified by:
    
    copy in interface XPutGetCollection<K>
    
    Specified by:
    
    copy in interface XPutGetEnum<K>
    
    Specified by:
    
    copy in interface XPutGetSequence<K>
    
    Specified by:
    
    copy in interface XPutGetSet<K>
    
    Specified by:
    
    copy in interface XSequence<K>
    
    Specified by:
    
    copy in interface XSet<K>
    
    Specified by:
    
    copy in interface XSettingEnum<K>
    
    Specified by:
    
    copy in interface XSettingSequence<K>
    
    Specified by:
    
    copy in interface XSortableEnum<K>
    
    Specified by:
    
    copy in interface XSortableSequence<K>
    
    Specified by:
    
    copy in interface XTable.Keys<K,V>
    
    Returns:
    
    a copy of this list
  - immure
```
public final EqConstHashEnum<K> immure()
```
    This method creates a EqConstHashEnum instance containing all (currently existing) elements of this EqConstHashEnum.
    No matter which hashing logic this instance uses, the new EqConstHashEnum instance always uses a STRONG EQUALATOR logic, using this instance's logic's HashEqualator.
    This is necessary to ensure that the EqConstHashEnum instance is really constant and does not (can not!) lose elements over time.
    If a EqConstHashEnum with volatile elements is needed (e.g. as a "read-only weak set"), an appropriate custom behavior EqConstHashEnum instance can be created via the various copy constructors.
    
    Specified by:
    
    immure in interface XBasicEnum<K>
    
    Specified by:
    
    immure in interface XGettingCollection<K>
    
    Specified by:
    
    immure in interface XGettingEnum<K>
    
    Specified by:
    
    immure in interface XGettingMap.Keys<K,V>
    
    Specified by:
    
    immure in interface XGettingSequence<K>
    
    Specified by:
    
    immure in interface XGettingSet<K>
    
    Specified by:
    
    immure in interface XProcessingMap.Keys<K,V>
    
    Specified by:
    
    immure in interface XProcessingSet<K>
    
    Returns:
    
    a new EqConstHashEnum instance strongly referencing this set's current elements.
  - view
```
public final XGettingEnum<K> view()
```
    Specified by:
    
    view in interface XGettingCollection<K>
    
    Specified by:
    
    view in interface XGettingEnum<K>
    
    Specified by:
    
    view in interface XGettingSequence<K>
  - range
```
public final XEnum<K> range(long lowIndex,
                            long highIndex)
```
    Specified by:
    
    range in interface XDecreasingEnum<K>
    
    Specified by:
    
    range in interface XDecreasingSequence<K>
    
    Specified by:
    
    range in interface XEnum<K>
    
    Specified by:
    
    range in interface XGettingEnum<K>
    
    Specified by:
    
    range in interface XGettingSequence<K>
    
    Specified by:
    
    range in interface XIncreasingEnum<K>
    
    Specified by:
    
    range in interface XIncreasingSequence<K>
    
    Specified by:
    
    range in interface XSettingEnum<K>
    
    Specified by:
    
    range in interface XSettingSequence<K>
  - view
```
public final XGettingEnum<K> view(long lowIndex,
                                  long highIndex)
```
    Specified by:
    
    view in interface XGettingEnum<K>
    
    Specified by:
    
    view in interface XGettingSequence<K>
    
    Specified by:
    
    view in interface XProcessingSequence<K>
  - toArray
```
public final K[] toArray(Class<K> type)
```
    Specified by:
    
    toArray in interface XGettingCollection<K>
  - iterate
```
public final <P extends Consumer<? super K>> P iterate(P procedure)
```
    Specified by:
    
    iterate in interface XGettingEnum<K>
    
    Specified by:
    
    iterate in interface XGettingSet<K>
    
    Specified by:
    
    iterate in interface XIterable<K>
    
    Specified by:
    
    iterate in interface XProcessingCollection<K>
  - join
```
public final <A> A join(BiConsumer<? super K,? super A> joiner,
                        A aggregate)
```
    Specified by:
    
    join in interface XGettingCollection<K>
    
    Specified by:
    
    join in interface XJoinable<K>
  - count
```
public final long count(K element)
```
    Specified by:
    
    count in interface XGettingCollection<K>
  - countBy
```
public final long countBy(Predicate<? super K> predicate)
```
    Specified by:
    
    countBy in interface XGettingCollection<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 of XGettingCollection.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 interface XGettingCollection<K>
  - search
```
public final K search(Predicate<? super K> predicate)
```
    Specified by:
    
    search in interface XGettingCollection<K>
  - max
```
public final K max(Comparator<? super K> comparator)
```
    Specified by:
    
    max in interface XGettingCollection<K>
  - min
```
public final K min(Comparator<? super K> comparator)
```
    Specified by:
    
    min in interface XGettingCollection<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 are WeakReference of SoftReference or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
    Note that WeakReference instances that are added to a a simple (non-volatile) implementation of a collection do NOT make the collection volatile, as the elements themselves (the reference instances) are still strongly referenced.
    
    Specified by:
    
    hasVolatileElements in interface ExtendedCollection<K>
    
    Specified by:
    
    hasVolatileElements in interface XGettingCollection<K>
    
    Returns:
    
    true if the collection contains volatile elements.
  - nullAllowed
```
public final boolean nullAllowed()
```
    Specified by:
    
    nullAllowed in interface ExtendedCollection<K>
  - containsSearched
```
public final boolean containsSearched(Predicate<? super K> predicate)
```
    Specified by:
    
    containsSearched in interface XGettingCollection<K>
  - applies
```
public final boolean applies(Predicate<? super K> predicate)
```
    Specified by:
    
    applies in interface XGettingCollection<K>
  - nullContained
```
public final boolean nullContained()
```
    Specified by:
    
    nullContained in interface XGettingCollection<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 as XGettingCollection.containsSearched(Predicate) with a Predicate implementation that checks for object identity. The only difference is a performance and usability advantage
    
    Specified by:
    
    containsId in interface XGettingCollection<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 interface XGettingCollection<K>
  - containsAll
```
public final boolean containsAll(XGettingCollection<? extends K> elements)
```
    Specified by:
    
    containsAll in interface XGettingCollection<K>
  - equals
```
public final boolean equals(XGettingCollection<? extends K> samples,
                            Equalator<? super K> equalator)
```
    Description copied from interface: XGettingCollection
    
    Returns true if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator) yields true.
    
    Specified by:
    
    equals in interface XGettingCollection<K>
  - equalsContent
```
public final boolean equalsContent(XGettingCollection<? extends K> samples,
                                   Equalator<? super K> equalator)
```
    Description copied from interface: XGettingCollection
    
    Returns true if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.
    Note that for colletion types that don't have a defined order of elements, this method is hardly usable (as is XGettingCollection.equals(Object) for them as defined in Collection). The core problem of comparing collections that have no defined order is that they aren't really reliably comparable to any other collection.
    
    Specified by:
    
    equalsContent in interface XGettingCollection<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 interface XGettingCollection<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 interface XGettingCollection<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 interface XGettingCollection<K>
  - copyTo
```
public final <C extends Consumer<? super K>> C copyTo(C target)
```
    Specified by:
    
    copyTo in interface XGettingCollection<K>
  - filterTo
```
public final <C extends Consumer<? super K>> C filterTo(C target,
                                                        Predicate<? super K> predicate)
```
    Specified by:
    
    filterTo in interface XGettingCollection<K>
  - distinct
```
public final <C extends Consumer<? super K>> C distinct(C target)
```
    Specified by:
    
    distinct in interface XGettingCollection<K>
  - distinct
```
public final <C extends Consumer<? super K>> C distinct(C target,
                                                        Equalator<? super K> equalator)
```
    Specified by:
    
    distinct in interface XGettingCollection<K>
  - currentCapacity
```
public final long currentCapacity()
```
    Description copied from interface: CapacityExtendable
    
    Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.
    For carrier implementations that don't have a concept of storage rebuilding (like linked list for example) this method returns the same value as CapacityCarrying.maximumCapacity().
    
    Specified by:
    
    currentCapacity in interface CapacityExtendable
    
    Returns:
    
    the current capacity of this instance before a rebuild is required.
  - 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 interface CapacityCarrying
    
    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 interface CapacityCarrying
  - optimize
```
public final long optimize()
```
    Description copied from interface: XRemovingCollection
    
    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. 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:
    
    optimize in interface OptimizableCollection
    
    Specified by:
    
    optimize in interface XRemovingCollection<K>
    
    Returns:
    
    the amount of elements that can be added before the internal storage has to be adjusted.
  - 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 interface HashCollection<K>
    
    Returns:
    
    the new size of the collection which might be lower than before the call.
  - ensureFreeCapacity
```
public final EqHashTable.Keys ensureFreeCapacity(long requiredFreeCapacity)
```
    Description copied from interface: CapacityExtendable
    
    Ensures that the next minimalFreeCapacity elements can be actually added in a fast way, meaning for example no internal storage rebuild will be necessary.
    
    Specified by:
    
    ensureFreeCapacity in interface CapacityExtendable
  - ensureCapacity
```
public final EqHashTable.Keys ensureCapacity(long minimalCapacity)
```
    Specified by:
    
    ensureCapacity in interface CapacityExtendable
  - nullAdd
```
public final boolean nullAdd()
```
    Specified by:
    
    nullAdd in interface XAddingCollection<K>
  - add
```
public final boolean add(K element)
```
    Specified by:
    
    add in interface XAddingCollection<K>
  - addAll
```
@SafeVarargs
public final EqHashTable.Keys addAll(K... elements)
```
    Specified by:
    
    addAll in interface XAddGetCollection<K>
    
    Specified by:
    
    addAll in interface XAddGetSet<K>
    
    Specified by:
    
    addAll in interface XAddingCollection<K>
    
    Specified by:
    
    addAll in interface XAddingEnum<K>
    
    Specified by:
    
    addAll in interface XAddingSequence<K>
    
    Specified by:
    
    addAll in interface XAddingSet<K>
    
    Specified by:
    
    addAll in interface XBasicEnum<K>
    
    Specified by:
    
    addAll in interface XBasicSequence<K>
    
    Specified by:
    
    addAll in interface XBasicTable.Keys<K,V>
    
    Specified by:
    
    addAll in interface XCollection<K>
    
    Specified by:
    
    addAll in interface XEnum<K>
    
    Specified by:
    
    addAll in interface XExpandingEnum<K>
    
    Specified by:
    
    addAll in interface XExpandingSequence<K>
    
    Specified by:
    
    addAll in interface XExtendingEnum<K>
    
    Specified by:
    
    addAll in interface XExtendingSequence<K>
    
    Specified by:
    
    addAll in interface XIncreasingEnum<K>
    
    Specified by:
    
    addAll in interface XIncreasingSequence<K>
    
    Specified by:
    
    addAll in interface XInputtingEnum<K>
    
    Specified by:
    
    addAll in interface XInputtingSequence<K>
    
    Specified by:
    
    addAll in interface XInsertingEnum<K>
    
    Specified by:
    
    addAll in interface XInsertingSequence<K>
    
    Specified by:
    
    addAll in interface XPutGetCollection<K>
    
    Specified by:
    
    addAll in interface XPutGetEnum<K>
    
    Specified by:
    
    addAll in interface XPutGetSequence<K>
    
    Specified by:
    
    addAll in interface XPutGetSet<K>
    
    Specified by:
    
    addAll in interface XPuttingEnum<K>
    
    Specified by:
    
    addAll in interface XPuttingSet<K>
    
    Specified by:
    
    addAll in interface XSequence<K>
    
    Specified by:
    
    addAll in interface XSet<K>
    
    Specified by:
    
    addAll in interface XTable.Keys<K,V>
  - addAll
```
public final EqHashTable.Keys addAll(K[] elements,
                                     int srcIndex,
                                     int srcLength)
```
    Specified by:
    
    addAll in interface XAddGetCollection<K>
    
    Specified by:
    
    addAll in interface XAddGetSet<K>
    
    Specified by:
    
    addAll in interface XAddingCollection<K>
    
    Specified by:
    
    addAll in interface XAddingEnum<K>
    
    Specified by:
    
    addAll in interface XAddingSequence<K>
    
    Specified by:
    
    addAll in interface XAddingSet<K>
    
    Specified by:
    
    addAll in interface XBasicEnum<K>
    
    Specified by:
    
    addAll in interface XBasicSequence<K>
    
    Specified by:
    
    addAll in interface XBasicTable.Keys<K,V>
    
    Specified by:
    
    addAll in interface XCollection<K>
    
    Specified by:
    
    addAll in interface XEnum<K>
    
    Specified by:
    
    addAll in interface XExpandingEnum<K>
    
    Specified by:
    
    addAll in interface XExpandingSequence<K>
    
    Specified by:
    
    addAll in interface XExtendingEnum<K>
    
    Specified by:
    
    addAll in interface XExtendingSequence<K>
    
    Specified by:
    
    addAll in interface XIncreasingEnum<K>
    
    Specified by:
    
    addAll in interface XIncreasingSequence<K>
    
    Specified by:
    
    addAll in interface XInputtingEnum<K>
    
    Specified by:
    
    addAll in interface XInputtingSequence<K>
    
    Specified by:
    
    addAll in interface XInsertingEnum<K>
    
    Specified by:
    
    addAll in interface XInsertingSequence<K>
    
    Specified by:
    
    addAll in interface XPutGetCollection<K>
    
    Specified by:
    
    addAll in interface XPutGetEnum<K>
    
    Specified by:
    
    addAll in interface XPutGetSequence<K>
    
    Specified by:
    
    addAll in interface XPutGetSet<K>
    
    Specified by:
    
    addAll in interface XPuttingEnum<K>
    
    Specified by:
    
    addAll in interface XPuttingSet<K>
    
    Specified by:
    
    addAll in interface XSequence<K>
    
    Specified by:
    
    addAll in interface XSet<K>
    
    Specified by:
    
    addAll in interface XTable.Keys<K,V>
  - addAll
```
public final EqHashTable.Keys addAll(XGettingCollection<? extends K> elements)
```
    Specified by:
    
    addAll in interface XAddGetCollection<K>
    
    Specified by:
    
    addAll in interface XAddGetSet<K>
    
    Specified by:
    
    addAll in interface XAddingCollection<K>
    
    Specified by:
    
    addAll in interface XAddingEnum<K>
    
    Specified by:
    
    addAll in interface XAddingSequence<K>
    
    Specified by:
    
    addAll in interface XAddingSet<K>
    
    Specified by:
    
    addAll in interface XBasicEnum<K>
    
    Specified by:
    
    addAll in interface XBasicSequence<K>
    
    Specified by:
    
    addAll in interface XBasicTable.Keys<K,V>
    
    Specified by:
    
    addAll in interface XCollection<K>
    
    Specified by:
    
    addAll in interface XEnum<K>
    
    Specified by:
    
    addAll in interface XExpandingEnum<K>
    
    Specified by:
    
    addAll in interface XExpandingSequence<K>
    
    Specified by:
    
    addAll in interface XExtendingEnum<K>
    
    Specified by:
    
    addAll in interface XExtendingSequence<K>
    
    Specified by:
    
    addAll in interface XIncreasingEnum<K>
    
    Specified by:
    
    addAll in interface XIncreasingSequence<K>
    
    Specified by:
    
    addAll in interface XInputtingEnum<K>
    
    Specified by:
    
    addAll in interface XInputtingSequence<K>
    
    Specified by:
    
    addAll in interface XInsertingEnum<K>
    
    Specified by:
    
    addAll in interface XInsertingSequence<K>
    
    Specified by:
    
    addAll in interface XPutGetCollection<K>
    
    Specified by:
    
    addAll in interface XPutGetEnum<K>
    
    Specified by:
    
    addAll in interface XPutGetSequence<K>
    
    Specified by:
    
    addAll in interface XPutGetSet<K>
    
    Specified by:
    
    addAll in interface XPuttingEnum<K>
    
    Specified by:
    
    addAll in interface XPuttingSet<K>
    
    Specified by:
    
    addAll in interface XSequence<K>
    
    Specified by:
    
    addAll in interface XSet<K>
    
    Specified by:
    
    addAll in interface XTable.Keys<K,V>
  - nullPut
```
public final boolean nullPut()
```
    Specified by:
    
    nullPut in interface XPuttingCollection<K>
  - accept
```
public final void accept(K element)
```
    Specified by:
    
    accept in interface Consumer<K>
    
    Specified by:
    
    accept in interface XAddingCollection<K>
  - put
```
public final boolean put(K element)
```
    Specified by:
    
    put in interface XPuttingCollection<K>
  - addGet
```
public final K addGet(K element)
```
    Specified by:
    
    addGet in interface XAddGetSet<K>
  - deduplicate
```
public K deduplicate(K element)
```
    Specified by:
    
    deduplicate in interface XAddGetSet<K>
  - putGet
```
public final K putGet(K element)
```
    Specified by:
    
    putGet in interface XPutGetSet<K>
  - replace
```
public final K replace(K element)
```
    Specified by:
    
    replace in interface XPutGetSet<K>
  - putAll
```
@SafeVarargs
public final EqHashTable.Keys putAll(K... elements)
```
    Specified by:
    
    putAll in interface XBasicEnum<K>
    
    Specified by:
    
    putAll in interface XBasicSequence<K>
    
    Specified by:
    
    putAll in interface XBasicTable.Keys<K,V>
    
    Specified by:
    
    putAll in interface XCollection<K>
    
    Specified by:
    
    putAll in interface XEnum<K>
    
    Specified by:
    
    putAll in interface XExpandingEnum<K>
    
    Specified by:
    
    putAll in interface XExpandingSequence<K>
    
    Specified by:
    
    putAll in interface XIncreasingEnum<K>
    
    Specified by:
    
    putAll in interface XIncreasingSequence<K>
    
    Specified by:
    
    putAll in interface XInputtingEnum<K>
    
    Specified by:
    
    putAll in interface XInputtingSequence<K>
    
    Specified by:
    
    putAll in interface XPutGetCollection<K>
    
    Specified by:
    
    putAll in interface XPutGetEnum<K>
    
    Specified by:
    
    putAll in interface XPutGetSequence<K>
    
    Specified by:
    
    putAll in interface XPutGetSet<K>
    
    Specified by:
    
    putAll in interface XPuttingCollection<K>
    
    Specified by:
    
    putAll in interface XPuttingEnum<K>
    
    Specified by:
    
    putAll in interface XPuttingSequence<K>
    
    Specified by:
    
    putAll in interface XPuttingSet<K>
    
    Specified by:
    
    putAll in interface XSequence<K>
    
    Specified by:
    
    putAll in interface XSet<K>
    
    Specified by:
    
    putAll in interface XTable.Keys<K,V>
  - putAll
```
public final EqHashTable.Keys putAll(K[] elements,
                                     int srcIndex,
                                     int srcLength)
```
    Specified by:
    
    putAll in interface XBasicEnum<K>
    
    Specified by:
    
    putAll in interface XBasicSequence<K>
    
    Specified by:
    
    putAll in interface XBasicTable.Keys<K,V>
    
    Specified by:
    
    putAll in interface XCollection<K>
    
    Specified by:
    
    putAll in interface XEnum<K>
    
    Specified by:
    
    putAll in interface XExpandingEnum<K>
    
    Specified by:
    
    putAll in interface XExpandingSequence<K>
    
    Specified by:
    
    putAll in interface XIncreasingEnum<K>
    
    Specified by:
    
    putAll in interface XIncreasingSequence<K>
    
    Specified by:
    
    putAll in interface XInputtingEnum<K>
    
    Specified by:
    
    putAll in interface XInputtingSequence<K>
    
    Specified by:
    
    putAll in interface XPutGetCollection<K>
    
    Specified by:
    
    putAll in interface XPutGetEnum<K>
    
    Specified by:
    
    putAll in interface XPutGetSequence<K>
    
    Specified by:
    
    putAll in interface XPutGetSet<K>
    
    Specified by:
    
    putAll in interface XPuttingCollection<K>
    
    Specified by:
    
    putAll in interface XPuttingEnum<K>
    
    Specified by:
    
    putAll in interface XPuttingSequence<K>
    
    Specified by:
    
    putAll in interface XPuttingSet<K>
    
    Specified by:
    
    putAll in interface XSequence<K>
    
    Specified by:
    
    putAll in interface XSet<K>
    
    Specified by:
    
    putAll in interface XTable.Keys<K,V>
  - putAll
```
public final EqHashTable.Keys putAll(XGettingCollection<? extends K> elements)
```
    Specified by:
    
    putAll in interface XBasicEnum<K>
    
    Specified by:
    
    putAll in interface XBasicSequence<K>
    
    Specified by:
    
    putAll in interface XBasicTable.Keys<K,V>
    
    Specified by:
    
    putAll in interface XCollection<K>
    
    Specified by:
    
    putAll in interface XEnum<K>
    
    Specified by:
    
    putAll in interface XExpandingEnum<K>
    
    Specified by:
    
    putAll in interface XExpandingSequence<K>
    
    Specified by:
    
    putAll in interface XIncreasingEnum<K>
    
    Specified by:
    
    putAll in interface XIncreasingSequence<K>
    
    Specified by:
    
    putAll in interface XInputtingEnum<K>
    
    Specified by:
    
    putAll in interface XInputtingSequence<K>
    
    Specified by:
    
    putAll in interface XPutGetCollection<K>
    
    Specified by:
    
    putAll in interface XPutGetEnum<K>
    
    Specified by:
    
    putAll in interface XPutGetSequence<K>
    
    Specified by:
    
    putAll in interface XPutGetSet<K>
    
    Specified by:
    
    putAll in interface XPuttingCollection<K>
    
    Specified by:
    
    putAll in interface XPuttingEnum<K>
    
    Specified by:
    
    putAll in interface XPuttingSequence<K>
    
    Specified by:
    
    putAll in interface XPuttingSet<K>
    
    Specified by:
    
    putAll in interface XSequence<K>
    
    Specified by:
    
    putAll in interface XSet<K>
    
    Specified by:
    
    putAll in interface XTable.Keys<K,V>
  - truncate
```
public final void truncate()
```
    Allocates a new internal storage with default size. No cutting of entry references is performed.
    This can be substantially faster than clear() as long as enough heap size is available but will also fragment heap much faster and thus slow down garbage collection compared to clear().
    To clear the set in a heap-clean way and reduce internal storage size to default, use both clear()and truncate().
    
    Specified by:
    
    truncate in interface Truncateable
    
    Specified by:
    
    truncate in interface XRemovingCollection<K>
    
    See Also:
    
    XRemovingCollection.truncate()
  - consolidate
```
public final long consolidate()
```
    Description copied from interface: XRemovingCollection
    
    Consolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore. (e.g. WeakReference entries whose reference has been cleared).
    If this is not possible or not needed in the concrete implementation, this method does nothing and returns 0.
    
    Specified by:
    
    consolidate in interface ConsolidatableCollection
    
    Specified by:
    
    consolidate in interface XRemovingCollection<K>
    
    Returns:
    
    the number of discarded entries.
  - remove
```
public final long remove(K element)
```
    Specified by:
    
    remove in interface XRemovingCollection<K>
  - nullRemove
```
public final long nullRemove()
```
    Specified by:
    
    nullRemove in interface XRemovingCollection<K>
  - removeBy
```
public final long removeBy(Predicate<? super K> predicate)
```
    Specified by:
    
    removeBy in interface XProcessingCollection<K>
  - retainAll
```
public final long retainAll(XGettingCollection<? extends K> elements)
```
    Specified by:
    
    retainAll in interface XRemovingCollection<K>
  - process
```
public final <P extends Consumer<? super K>> P process(P procedure)
```
    Specified by:
    
    process in interface Processable<K>
  - moveTo
```
public final <C extends Consumer<? super K>> C moveTo(C target,
                                                      Predicate<? super K> predicate)
```
    Specified by:
    
    moveTo in interface XProcessingCollection<K>
  - removeAll
```
public final long removeAll(XGettingCollection<? extends K> elements)
```
    Specified by:
    
    removeAll in interface XRemovingCollection<K>
  - removeDuplicates
```
public final long removeDuplicates()
```
    Specified by:
    
    removeDuplicates in interface XRemovingCollection<K>
  - removeDuplicates
```
public final long removeDuplicates(Equalator<? super K> equalator)
```
    Specified by:
    
    removeDuplicates in interface XProcessingCollection<K>
  - toReversed
```
public final EqHashTable.Keys toReversed()
```
    Specified by:
    
    toReversed in interface XBasicEnum<K>
    
    Specified by:
    
    toReversed in interface XBasicSequence<K>
    
    Specified by:
    
    toReversed in interface XDecreasingEnum<K>
    
    Specified by:
    
    toReversed in interface XDecreasingSequence<K>
    
    Specified by:
    
    toReversed in interface XEnum<K>
    
    Specified by:
    
    toReversed in interface XGettingEnum<K>
    
    Specified by:
    
    toReversed in interface XGettingSequence<K>
    
    Specified by:
    
    toReversed in interface XIncreasingEnum<K>
    
    Specified by:
    
    toReversed in interface XIncreasingSequence<K>
    
    Specified by:
    
    toReversed in interface XProcessingEnum<K>
    
    Specified by:
    
    toReversed in interface XProcessingSequence<K>
    
    Specified by:
    
    toReversed in interface XPutGetEnum<K>
    
    Specified by:
    
    toReversed in interface XPutGetSequence<K>
    
    Specified by:
    
    toReversed in interface XSequence<K>
    
    Specified by:
    
    toReversed in interface XSettingEnum<K>
    
    Specified by:
    
    toReversed in interface XSettingSequence<K>
    
    Specified by:
    
    toReversed in interface XSortableEnum<K>
    
    Specified by:
    
    toReversed in interface XSortableSequence<K>
  - copySelection
```
public final <T extends Consumer<? super K>> T copySelection(T target,
                                                             long... indices)
```
    Specified by:
    
    copySelection in interface XGettingSequence<K>
  - iterateIndexed
```
public final <P extends IndexedAcceptor<? super K>> P iterateIndexed(P procedure)
```
    Specified by:
    
    iterateIndexed in interface XIndexIterable<K>
  - at
```
public final K at(long index)
```
    Specified by:
    
    at in interface XGettingSequence<K>
  - get
```
public final K get()
```
    Description copied from interface: XGettingCollection
    
    Gets one element from the collection. If the collection is not ordered XGettingSequence, then it is undefined which element is returned. If the collection is ordered, the element at index 0 is returned.
    
    Specified by:
    
    get in interface XGettingCollection<K>
    
    Specified by:
    
    get in interface XGettingSequence<K>
    
    Returns:
    
    the first / any element.
    
    See Also:
    
    XGettingSequence.at(long), XGettingSequence.first(), XGettingSequence.last()
  - first
```
public final K first()
```
    Specified by:
    
    first in interface XGettingSequence<K>
  - last
```
public final K last()
```
    Specified by:
    
    last in interface XGettingSequence<K>
  - poll
```
public final K poll()
```
    Specified by:
    
    poll in interface XGettingSequence<K>
  - peek
```
public final K peek()
```
    Specified by:
    
    peek in interface XGettingSequence<K>
  - indexOf
```
public final long indexOf(K element)
```
    Specified by:
    
    indexOf in interface XGettingSequence<K>
  - indexBy
```
public final long indexBy(Predicate<? super K> predicate)
```
    Specified by:
    
    indexBy in interface XGettingSequence<K>
  - isSorted
```
public final boolean isSorted(Comparator<? super K> comparator)
```
    Specified by:
    
    isSorted in interface XGettingSequence<K>
  - lastIndexOf
```
public final long lastIndexOf(K element)
```
    Specified by:
    
    lastIndexOf in interface XGettingSequence<K>
  - lastIndexBy
```
public final long lastIndexBy(Predicate<? super K> predicate)
```
    Specified by:
    
    lastIndexBy in interface XGettingSequence<K>
  - maxIndex
```
public final long maxIndex(Comparator<? super K> comparator)
```
    Specified by:
    
    maxIndex in interface XGettingSequence<K>
  - minIndex
```
public final long minIndex(Comparator<? super K> comparator)
```
    Specified by:
    
    minIndex in interface XGettingSequence<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 passed Predicateapplied to ("scanning").
    
    Specified by:
    
    scan in interface XGettingSequence<K>
    
    Returns:
    
    the index of the last positively tested element.
  - moveSelection
```
public final <C extends Consumer<? super K>> C moveSelection(C target,
                                                             long... indices)
```
    Specified by:
    
    moveSelection in interface XProcessingSequence<K>
  - removeAt
```
public final K removeAt(long index)
```
    Specified by:
    
    removeAt in interface XProcessingSequence<K>
  - fetch
```
public final K fetch()
```
    Specified by:
    
    fetch in interface XProcessingCollection<K>
  - pop
```
public final K pop()
```
    Specified by:
    
    pop in interface XProcessingSequence<K>
  - pinch
```
public final K pinch()
```
    Specified by:
    
    pinch in interface XProcessingCollection<K>
  - pick
```
public final K pick()
```
    Specified by:
    
    pick in interface XProcessingSequence<K>
  - retrieve
```
public final K retrieve(K element)
```
    Specified by:
    
    retrieve in interface XProcessingCollection<K>
  - retrieveBy
```
public final K retrieveBy(Predicate<? super K> predicate)
```
    Specified by:
    
    retrieveBy in interface XProcessingCollection<K>
  - removeOne
```
public final boolean removeOne(K element)
```
    Specified by:
    
    removeOne in interface XRemovingCollection<K>
  - removeRange
```
public final EqHashTable.Keys removeRange(long startIndex,
                                          long length)
```
    Specified by:
    
    removeRange in interface XRemovingSequence<K>
  - retainRange
```
public final EqHashTable.Keys retainRange(long startIndex,
                                          long length)
```
    Specified by:
    
    retainRange in interface XRemovingSequence<K>
  - removeSelection
```
public final long removeSelection(long[] indices)
```
    Specified by:
    
    removeSelection in interface XRemovingSequence<K>
  - isEmpty
```
public final boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Sized
  - iterator
```
public final Iterator<K> iterator()
```
    Specified by:
    
    iterator in interface Iterable<K>
    
    Specified by:
    
    iterator in interface XGettingCollection<K>
  - size
```
public final long size()
```
    Specified by:
    
    size in interface HashCollection<K>
    
    Specified by:
    
    size in interface Sized
    
    Specified by:
    
    size in interface XGettingCollection<K>
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - toArray
```
public final Object[] toArray()
```
    Specified by:
    
    toArray in interface XGettingCollection<K>
  - clear
```
public final void clear()
```
    Cuts all references to existing entries, effectively clearing the set.
    The internal storage remains at its current size. All inter-entry references are cut as well, easing garbage collection of discarded entry instances belonging to different generations.
    To simply reallocate a new internal storage with default size, see truncate()
    
    Specified by:
    
    clear in interface Clearable
    
    Specified by:
    
    clear in interface XRemovingCollection<K>
    
    See Also:
    
    XRemovingCollection.clear()
  - reverse
```
public final EqHashTable.Keys reverse()
```
    Specified by:
    
    reverse in interface XDecreasingEnum<K>
    
    Specified by:
    
    reverse in interface XDecreasingSequence<K>
    
    Specified by:
    
    reverse in interface XEnum<K>
    
    Specified by:
    
    reverse in interface XIncreasingEnum<K>
    
    Specified by:
    
    reverse in interface XIncreasingSequence<K>
    
    Specified by:
    
    reverse in interface XOrderingEnum<K>
    
    Specified by:
    
    reverse in interface XOrderingSequence<K>
    
    Specified by:
    
    reverse in interface XSettingEnum<K>
    
    Specified by:
    
    reverse in interface XSettingSequence<K>
    
    Specified by:
    
    reverse in interface XSortableEnum<K>
    
    Specified by:
    
    reverse in interface XSortableSequence<K>
  - sort
```
public final EqHashTable.Keys sort(Comparator<? super K> comparator)
```
    Specified by:
    
    sort in interface Sortable<K>
    
    Specified by:
    
    sort in interface XDecreasingEnum<K>
    
    Specified by:
    
    sort in interface XDecreasingSequence<K>
    
    Specified by:
    
    sort in interface XEnum<K>
    
    Specified by:
    
    sort in interface XIncreasingEnum<K>
    
    Specified by:
    
    sort in interface XIncreasingSequence<K>
    
    Specified by:
    
    sort in interface XSequence<K>
    
    Specified by:
    
    sort in interface XSettingEnum<K>
    
    Specified by:
    
    sort in interface XSettingSequence<K>
    
    Specified by:
    
    sort in interface XSortableEnum<K>
    
    Specified by:
    
    sort in interface XSortableSequence<K>
  - shiftTo
```
public final EqHashTable.Keys shiftTo(long sourceIndex,
                                      long targetIndex)
```
    Specified by:
    
    shiftTo in interface XOrderingEnum<K>
    
    Specified by:
    
    shiftTo in interface XOrderingSequence<K>
    
    Specified by:
    
    shiftTo in interface XSortableEnum<K>
    
    Specified by:
    
    shiftTo in interface XSortableSequence<K>
  - shiftTo
```
public final EqHashTable.Keys shiftTo(long sourceIndex,
                                      long targetIndex,
                                      long length)
```
    Specified by:
    
    shiftTo in interface XOrderingEnum<K>
    
    Specified by:
    
    shiftTo in interface XOrderingSequence<K>
    
    Specified by:
    
    shiftTo in interface XSortableEnum<K>
    
    Specified by:
    
    shiftTo in interface XSortableSequence<K>
  - shiftBy
```
public final EqHashTable.Keys shiftBy(long sourceIndex,
                                      long distance)
```
    Specified by:
    
    shiftBy in interface XOrderingEnum<K>
    
    Specified by:
    
    shiftBy in interface XOrderingSequence<K>
    
    Specified by:
    
    shiftBy in interface XSortableEnum<K>
    
    Specified by:
    
    shiftBy in interface XSortableSequence<K>
  - shiftBy
```
public final EqHashTable.Keys shiftBy(long sourceIndex,
                                      long distance,
                                      long length)
```
    Specified by:
    
    shiftBy in interface XOrderingEnum<K>
    
    Specified by:
    
    shiftBy in interface XOrderingSequence<K>
    
    Specified by:
    
    shiftBy in interface XSortableEnum<K>
    
    Specified by:
    
    shiftBy in interface XSortableSequence<K>
  - swap
```
public final EqHashTable.Keys swap(long indexA,
                                   long indexB)
```
    Specified by:
    
    swap in interface XDecreasingEnum<K>
    
    Specified by:
    
    swap in interface XDecreasingSequence<K>
    
    Specified by:
    
    swap in interface XEnum<K>
    
    Specified by:
    
    swap in interface XIncreasingEnum<K>
    
    Specified by:
    
    swap in interface XIncreasingSequence<K>
    
    Specified by:
    
    swap in interface XOrderingEnum<K>
    
    Specified by:
    
    swap in interface XOrderingSequence<K>
    
    Specified by:
    
    swap in interface XSettingEnum<K>
    
    Specified by:
    
    swap in interface XSettingSequence<K>
    
    Specified by:
    
    swap in interface XSortableEnum<K>
    
    Specified by:
    
    swap in interface XSortableSequence<K>
  - swap
```
public final EqHashTable.Keys swap(long indexA,
                                   long indexB,
                                   long length)
```
    Specified by:
    
    swap in interface XDecreasingEnum<K>
    
    Specified by:
    
    swap in interface XDecreasingSequence<K>
    
    Specified by:
    
    swap in interface XEnum<K>
    
    Specified by:
    
    swap in interface XIncreasingEnum<K>
    
    Specified by:
    
    swap in interface XIncreasingSequence<K>
    
    Specified by:
    
    swap in interface XOrderingEnum<K>
    
    Specified by:
    
    swap in interface XOrderingSequence<K>
    
    Specified by:
    
    swap in interface XSettingEnum<K>
    
    Specified by:
    
    swap in interface XSettingSequence<K>
    
    Specified by:
    
    swap in interface XSortableEnum<K>
    
    Specified by:
    
    swap in interface XSortableSequence<K>
  - old
```
public final EqHashTable.Keys.OldKeys old()
```
    Specified by:
    
    old in interface XGettingCollection<K>
  - parent
```
public final EqHashTable<K,V> parent()
```
    Specified by:
    
    parent in interface XBasicTable.Keys<K,V>
    
    Specified by:
    
    parent in interface XGettingMap.Satellite<K,V>
    
    Specified by:
    
    parent in interface XGettingTable.Keys<K,V>
    
    Specified by:
    
    parent in interface XGettingTable.Satellite<K,V>
    
    Specified by:
    
    parent in interface XMap.Satellite<K,V>
    
    Specified by:
    
    parent in interface XTable.Keys<K,V>
  - hashEquality
```
public final HashEqualator<? super K> hashEquality()
```
    Specified by:
    
    hashEquality in interface HashCollection<K>
  - hashDensity
```
public final float hashDensity()
```
    Specified by:
    
    hashDensity in interface HashCollection<K>
  - input
```
public final boolean input(long index,
                           K element)
```
    Specified by:
    
    input in interface XInputtingSequence<K>
  - inputAll
```
@SafeVarargs
public final long inputAll(long index,
                           K... elements)
```
    Specified by:
    
    inputAll in interface XInputtingSequence<K>
  - inputAll
```
public final long inputAll(long index,
                           K[] elements,
                           int offset,
                           int length)
```
    Specified by:
    
    inputAll in interface XInputtingSequence<K>
  - inputAll
```
public final long inputAll(long index,
                           XGettingCollection<? extends K> elements)
```
    Specified by:
    
    inputAll in interface XInputtingSequence<K>
  - insert
```
public final boolean insert(long index,
                            K element)
```
    Specified by:
    
    insert in interface XInsertingSequence<K>
  - insertAll
```
@SafeVarargs
public final long insertAll(long index,
                            K... elements)
```
    Specified by:
    
    insertAll in interface XInsertingSequence<K>
  - insertAll
```
public final long insertAll(long index,
                            K[] elements,
                            int offset,
                            int length)
```
    Specified by:
    
    insertAll in interface XInsertingSequence<K>
  - insertAll
```
public final long insertAll(long index,
                            XGettingCollection<? extends K> elements)
```
    Specified by:
    
    insertAll in interface XInsertingSequence<K>
  - prepend
```
public final boolean prepend(K element)
```
    Specified by:
    
    prepend in interface XPrependingSequence<K>
  - preput
```
public final boolean preput(K element)
```
    Specified by:
    
    preput in interface XPreputtingSequence<K>
  - nullInput
```
public final boolean nullInput(long index)
```
    Specified by:
    
    nullInput in interface XInputtingSequence<K>
  - nullInsert
```
public final boolean nullInsert(long index)
```
    Specified by:
    
    nullInsert in interface XInsertingSequence<K>
  - nullPrepend
```
public final boolean nullPrepend()
```
    Specified by:
    
    nullPrepend in interface XPrependingSequence<K>
  - prependAll
```
public final EqHashTable.Keys prependAll(K... elements)
```
    Specified by:
    
    prependAll in interface XEnum<K>
    
    Specified by:
    
    prependAll in interface XExpandingEnum<K>
    
    Specified by:
    
    prependAll in interface XExpandingSequence<K>
    
    Specified by:
    
    prependAll in interface XExtendingEnum<K>
    
    Specified by:
    
    prependAll in interface XExtendingSequence<K>
    
    Specified by:
    
    prependAll in interface XIncreasingEnum<K>
    
    Specified by:
    
    prependAll in interface XIncreasingSequence<K>
    
    Specified by:
    
    prependAll in interface XInputtingEnum<K>
    
    Specified by:
    
    prependAll in interface XInputtingSequence<K>
    
    Specified by:
    
    prependAll in interface XInsertingEnum<K>
    
    Specified by:
    
    prependAll in interface XInsertingSequence<K>
    
    Specified by:
    
    prependAll in interface XPrependingEnum<K>
    
    Specified by:
    
    prependAll in interface XPrependingSequence<K>
    
    Specified by:
    
    prependAll in interface XPreputtingEnum<K>
    
    Specified by:
    
    prependAll in interface XPreputtingSequence<K>
  - prependAll
```
public final EqHashTable.Keys prependAll(K[] elements,
                                         int srcStartIndex,
                                         int srcLength)
```
    Specified by:
    
    prependAll in interface XEnum<K>
    
    Specified by:
    
    prependAll in interface XExpandingEnum<K>
    
    Specified by:
    
    prependAll in interface XExpandingSequence<K>
    
    Specified by:
    
    prependAll in interface XExtendingEnum<K>
    
    Specified by:
    
    prependAll in interface XExtendingSequence<K>
    
    Specified by:
    
    prependAll in interface XIncreasingEnum<K>
    
    Specified by:
    
    prependAll in interface XIncreasingSequence<K>
    
    Specified by:
    
    prependAll in interface XInputtingEnum<K>
    
    Specified by:
    
    prependAll in interface XInputtingSequence<K>
    
    Specified by:
    
    prependAll in interface XInsertingEnum<K>
    
    Specified by:
    
    prependAll in interface XInsertingSequence<K>
    
    Specified by:
    
    prependAll in interface XPrependingEnum<K>
    
    Specified by:
    
    prependAll in interface XPrependingSequence<K>
    
    Specified by:
    
    prependAll in interface XPreputtingEnum<K>
    
    Specified by:
    
    prependAll in interface XPreputtingSequence<K>
  - prependAll
```
public final EqHashTable.Keys prependAll(XGettingCollection<? extends K> elements)
```
    Specified by:
    
    prependAll in interface XEnum<K>
    
    Specified by:
    
    prependAll in interface XExpandingEnum<K>
    
    Specified by:
    
    prependAll in interface XExpandingSequence<K>
    
    Specified by:
    
    prependAll in interface XExtendingEnum<K>
    
    Specified by:
    
    prependAll in interface XExtendingSequence<K>
    
    Specified by:
    
    prependAll in interface XIncreasingEnum<K>
    
    Specified by:
    
    prependAll in interface XIncreasingSequence<K>
    
    Specified by:
    
    prependAll in interface XInputtingEnum<K>
    
    Specified by:
    
    prependAll in interface XInputtingSequence<K>
    
    Specified by:
    
    prependAll in interface XInsertingEnum<K>
    
    Specified by:
    
    prependAll in interface XInsertingSequence<K>
    
    Specified by:
    
    prependAll in interface XPrependingEnum<K>
    
    Specified by:
    
    prependAll in interface XPrependingSequence<K>
    
    Specified by:
    
    prependAll in interface XPreputtingEnum<K>
    
    Specified by:
    
    prependAll in interface XPreputtingSequence<K>
  - nullPreput
```
public final boolean nullPreput()
```
    Specified by:
    
    nullPreput in interface XPreputtingSequence<K>
  - preputAll
```
@SafeVarargs
public final EqHashTable.Keys preputAll(K... elements)
```
    Specified by:
    
    preputAll in interface XEnum<K>
    
    Specified by:
    
    preputAll in interface XExpandingEnum<K>
    
    Specified by:
    
    preputAll in interface XExpandingSequence<K>
    
    Specified by:
    
    preputAll in interface XIncreasingEnum<K>
    
    Specified by:
    
    preputAll in interface XIncreasingSequence<K>
    
    Specified by:
    
    preputAll in interface XInputtingEnum<K>
    
    Specified by:
    
    preputAll in interface XInputtingSequence<K>
    
    Specified by:
    
    preputAll in interface XPreputtingEnum<K>
    
    Specified by:
    
    preputAll in interface XPreputtingSequence<K>
  - preputAll
```
public final EqHashTable.Keys preputAll(K[] elements,
                                        int offset,
                                        int length)
```
    Specified by:
    
    preputAll in interface XEnum<K>
    
    Specified by:
    
    preputAll in interface XExpandingEnum<K>
    
    Specified by:
    
    preputAll in interface XExpandingSequence<K>
    
    Specified by:
    
    preputAll in interface XIncreasingEnum<K>
    
    Specified by:
    
    preputAll in interface XIncreasingSequence<K>
    
    Specified by:
    
    preputAll in interface XInputtingEnum<K>
    
    Specified by:
    
    preputAll in interface XInputtingSequence<K>
    
    Specified by:
    
    preputAll in interface XPreputtingEnum<K>
    
    Specified by:
    
    preputAll in interface XPreputtingSequence<K>
  - preputAll
```
public final EqHashTable.Keys preputAll(XGettingCollection<? extends K> elements)
```
    Specified by:
    
    preputAll in interface XEnum<K>
    
    Specified by:
    
    preputAll in interface XExpandingEnum<K>
    
    Specified by:
    
    preputAll in interface XExpandingSequence<K>
    
    Specified by:
    
    preputAll in interface XIncreasingEnum<K>
    
    Specified by:
    
    preputAll in interface XIncreasingSequence<K>
    
    Specified by:
    
    preputAll in interface XInputtingEnum<K>
    
    Specified by:
    
    preputAll in interface XInputtingSequence<K>
    
    Specified by:
    
    preputAll in interface XPreputtingEnum<K>
    
    Specified by:
    
    preputAll in interface XPreputtingSequence<K>
  - set
```
public final boolean set(long index,
                         K element)
```
    Specified by:
    
    set in interface XSettingSequence<K>
  - setGet
```
public final K setGet(long index,
                      K element)
```
    Specified by:
    
    setGet in interface XSettingEnum<K>
    
    Specified by:
    
    setGet in interface XSettingSequence<K>
  - setFirst
```
public final void setFirst(K element)
```
    Specified by:
    
    setFirst in interface XSettingEnum<K>
    
    Specified by:
    
    setFirst in interface XSettingSequence<K>
  - setLast
```
public final void setLast(K element)
```
    Specified by:
    
    setLast in interface XSettingEnum<K>
    
    Specified by:
    
    setLast in interface XSettingSequence<K>
  - setAll
```
@SafeVarargs
public final EqHashTable.Keys setAll(long index,
                                     K... elements)
```
    Specified by:
    
    setAll in interface XDecreasingEnum<K>
    
    Specified by:
    
    setAll in interface XDecreasingSequence<K>
    
    Specified by:
    
    setAll in interface XEnum<K>
    
    Specified by:
    
    setAll in interface XSettingEnum<K>
    
    Specified by:
    
    setAll in interface XSettingSequence<K>
  - set
```
public final EqHashTable.Keys set(long index,
                                  K[] elements,
                                  int offset,
                                  int length)
```
    Specified by:
    
    set in interface XDecreasingEnum<K>
    
    Specified by:
    
    set in interface XDecreasingSequence<K>
    
    Specified by:
    
    set in interface XEnum<K>
    
    Specified by:
    
    set in interface XSettingEnum<K>
    
    Specified by:
    
    set in interface XSettingSequence<K>
  - set
```
public final EqHashTable.Keys set(long index,
                                  XGettingSequence<? extends K> elements,
                                  long offset,
                                  long length)
```
    Specified by:
    
    set in interface XDecreasingEnum<K>
    
    Specified by:
    
    set in interface XDecreasingSequence<K>
    
    Specified by:
    
    set in interface XEnum<K>
    
    Specified by:
    
    set in interface XSettingEnum<K>
    
    Specified by:
    
    set in interface XSettingSequence<K>
  - substitute
```
public long substitute(Function<? super K,? extends K> mapper)
```
    Specified by:
    
    substitute in interface XDecreasingEnum<K>
    
    Specified by:
    
    substitute in interface XReplacingCollection<K>

Class EqHashTable.Keys

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.typing.Copyable

Nested classes/interfaces inherited from interface one.microstream.collections.interfaces.ExtendedCollection

Nested classes/interfaces inherited from interface one.microstream.collections.interfaces.HashCollection

Nested classes/interfaces inherited from interface one.microstream.collections.types.XAddGetCollection

Nested classes/interfaces inherited from interface one.microstream.collections.types.XAddingSet

Nested classes/interfaces inherited from interface one.microstream.collections.types.XBasicEnum

Nested classes/interfaces inherited from interface one.microstream.collections.types.XBasicSequence

Nested classes/interfaces inherited from interface one.microstream.collections.types.XEnum

Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingCollection

Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingEnum

Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingSequence

Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingSet

Nested classes/interfaces inherited from interface one.microstream.collections.types.XIncreasingEnum

Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable

Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingSequence

Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingSet

Nested classes/interfaces inherited from interface one.microstream.collections.types.XPutGetCollection

Nested classes/interfaces inherited from interface one.microstream.collections.types.XPutGetSequence

Nested classes/interfaces inherited from interface one.microstream.collections.types.XPutGetSet

Nested classes/interfaces inherited from interface one.microstream.collections.types.XPuttingSet

Nested classes/interfaces inherited from interface one.microstream.collections.types.XRemovingEnum

Nested classes/interfaces inherited from interface one.microstream.collections.types.XSet

Field Summary

Fields inherited from interface one.microstream.collections.interfaces.HashCollection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface one.microstream.collections.interfaces.CapacityCarrying

Methods inherited from interface one.microstream.collections.interfaces.CapacityExtendable

Methods inherited from interface java.util.function.Consumer

Methods inherited from interface java.lang.Iterable

Methods inherited from interface one.microstream.collections.types.XCollection

Methods inherited from interface one.microstream.collections.types.XGettingCollection

Methods inherited from interface one.microstream.collections.types.XGettingSequence

Constructor Detail

Keys

Method Detail

hashDistributionRange

hasVolatileHashElements

setHashDensity

analyze

equality

copy

immure

view

range

view

toArray

iterate

join

count

countBy

seek

search

max

min

hasVolatileElements

nullAllowed

containsSearched

applies

nullContained

containsId

contains

containsAll

equals

equalsContent

intersect

except

union

copyTo

filterTo

distinct

distinct

currentCapacity

maximumCapacity

isFull

optimize

rehash