EqHashTable.Keys (MicroStream API)

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 and Description

class EqHashTable.Keys.OldKeys
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XEnum
  XEnum.Creator<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XSet
  XSet.Factory<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.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.interfaces.HashCollection
  HashCollection.Analysis<H>

Nested Classes
Modifier and Type	Class and Description
`class`	`EqHashTable.Keys.OldKeys`

Field Summary
- Fields inherited from interface one.microstream.collections.interfaces.HashCollection
  DEFAULT_HASH_FACTOR, DEFAULT_HASH_LENGTH

Constructor Summary

Constructors
Constructor and Description

Keys()

Constructors
Constructor and Description
`Keys()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(K element)`
`boolean`	`add(K element)` Adds the passed 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)` Tests each element of the collection on the given 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)` Checks if the given element is contained in the collection.
`boolean`	`containsAll(XGettingCollection<? extends K> elements)`
`boolean`	`containsId(K element)` Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic. This method has the same behavior 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)` Iterates through all the elements of the given indices and calls the `Consumer.accept(Object)` on the target `Consumer`.
`<C extends Consumer<? super K>> C`	`copyTo(C target)` Calls `Consumer.accept(Object)` on the target `Consumer` for all the elements of this collection.
`long`	`count(K element)` Count how many times this element matches another element in the collection using the `Equalator`.
`long`	`countBy(Predicate<? super K> predicate)` Count how many matches are found using the given predicate on each element of the collection.
`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)` Calls `Consumer.accept(Object)` on the target `Consumer` for all the unique/distinct elements of this collection.
`<C extends Consumer<? super K>> C`	`distinct(C target, Equalator<? super K> equalator)` Calls `Consumer.accept(Object)` on the target `Consumer` for all the unique/distinct elements of this collection.
`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)`
`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)` Calls `Consumer.accept(Object)` on the target `Consumer` for each element of this collection that is not contained in the other collection (through the given equalator).
`K`	`fetch()`
`<C extends Consumer<? super K>> C`	`filterTo(C target, Predicate<? super K> predicate)` Calls `Consumer.accept(Object)` on the target `Consumer` for all the elements of this collection which test `true` on the given predicate.
`K`	`first()` Gets first element or throws `IndexOutOfBoundsException` if the collection is empty.
`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)` Iterates forwards through the collection and returns the index of the first element that the passed {link Predicate} applies to immediately. Stops iterating on the first element that the predicate applies to.
`long`	`indexOf(K element)`
`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)` Tests equality between each element of the two lists and calls `Consumer.accept(Object)` on the target `Consumer` for the equal elements. Therefore it effectively creates a mathematical intersection between the two collections.
`boolean`	`isEmpty()`
`boolean`	`isFull()`
`boolean`	`isSorted(Comparator<? super K> comparator)` Tests if the collection is sorted according to the given comparator.
`<P extends Consumer<? super K>> P`	`iterate(P procedure)` Executes the given procedure for each element of the `XIterable` until all elements have been processed or the action throws an exception.
`<P extends IndexedAcceptor<? super K>> P`	`iterateIndexed(P procedure)` Iterates over elements with the `IndexedAcceptor` to use not only the element itself but also its coherent index.
`Iterator<K>`	`iterator()`
`<A> A`	`join(BiConsumer<? super K,? super A> joiner, A aggregate)` Iterates over all elements of the collections and calls the joiner with each element and the aggregate.
`K`	`last()` Gets last element or throws `IndexOutOfBoundsException` if the collection is empty.
`long`	`lastIndexBy(Predicate<? super K> predicate)` Iterates backwards through the collection and returns the index of the last element that the passed `Predicate` applies to immediately. Stops iterating on the first element that the predicate applies to.
`long`	`lastIndexOf(K element)`
`K`	`max(Comparator<? super K> comparator)`
`long`	`maximumCapacity()` Returns the maximum amount of elements this carrier instance can contain. The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g.
`long`	`maxIndex(Comparator<? super K> comparator)`
`K`	`min(Comparator<? super K> comparator)`
`long`	`minIndex(Comparator<? super K> comparator)`
`<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()` Defines if null-elements are allowed inside the collection or not.
`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()` Gets last element or null if the collection is empty.
`K`	`pick()`
`K`	`pinch()`
`K`	`poll()` Gets first element or null if the collection is empty.
`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)` Adds the specified element to this collection if it is not already present (optional operation).
`EqHashTable.Keys`	`putAll(K... elements)` Adds the specified elements to this collection if it is not already present (optional operation).
`EqHashTable.Keys`	`putAll(K[] elements, int srcIndex, int srcLength)` Adds the specified elements to this collection if it is not already present (optional operation). Only the elements with indizes from the srcStartIndex to the srcStartIndex+srcLength are put in the collection.
`EqHashTable.Keys`	`putAll(XGettingCollection<? extends K> elements)` Adds the specified elements to this collection if it is not already present (optional operation).
`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)` Removing all elements except the ones contained in the given elements-collection.
`EqHashTable.Keys`	`retainRange(long startIndex, long length)` Removing all elements but the ones from the offset (basically start index) to the offset+length (end index).
`K`	`retrieve(K element)`
`K`	`retrieveBy(Predicate<? super K> predicate)`
`EqHashTable.Keys`	`reverse()` Reverses the order of its own elements and returns itself.
`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)` Returns the first contained element matching the passed predicate.
`K`	`seek(K sample)` Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained.
`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)` Moves the element from the sourceIndex in the sequence to a higher index position. All other elements are possibly moved to create the empty slot for the shifting element.
`EqHashTable.Keys`	`shiftBy(long sourceIndex, long distance, long length)` Moves multiple elements from the sourceIndex in the sequence to a higher index position. All other elements are possibly moved to create the empty slot for the shifting elements.
`EqHashTable.Keys`	`shiftTo(long sourceIndex, long targetIndex)` Moves the element from the sourceIndex in the sequence to the targetIndex. All other elements are possibly moved to create the empty slot for the shifting element.
`EqHashTable.Keys`	`shiftTo(long sourceIndex, long targetIndex, long length)` Moves multiple elements from the sourceIndex in the sequence to the targetIndex. All other elements are possibly moved to create the empty slot for the shifting element.
`long`	`size()`
`EqHashTable.Keys`	`sort(Comparator<? super K> comparator)` Sorts this collection according to the given comparator and returns itself.
`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()` Returns an array containing all of the elements in this collection.
`K[]`	`toArray(Class<K> type)` Returns a typed array containing all of the elements in this collection.
`EqHashTable.Keys`	`toReversed()` Creates a new `XGettingSequence` with the reversed order of elements.
`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)` Calls `Consumer.accept(Object)` on the target `Consumer` for all the elements of this collection.
`XGettingEnum<K>`	`view()` Creates a view of this collection and returns it.
`XGettingEnum<K>`	`view(long lowIndex, long highIndex)` Creates a sub-view of this collection and returns it.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

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

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

Methods inherited from interface one.microstream.collections.sorting.SortableProcedure
sortIfApplicable

- 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 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>
    
    Specified by:
    
    copy in interface Copyable
    
    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()
```
    Description copied from interface: XGettingCollection
    
    Creates a view of this collection and returns it. It is a read-only collection, which wraps around this collection and only allows read methods.
    A view is different from immutable collection (XGettingCollection.immure()) in the way, that changes in this collection are still affecting the view. The immutable collection on the other hand has no reference to this collection and changes therefore do not affect the immutable collection.
    
    Specified by:
    
    view in interface XGettingCollection<K>
    
    Specified by:
    
    view in interface XGettingEnum<K>
    
    Specified by:
    
    view in interface XGettingSequence<K>
    
    Returns:
    
    new read-only collection to view this collection
  - 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)
```
    Description copied from interface: XGettingSequence
    
    Creates a sub-view of this collection and returns it. It is a read-only collection, which wraps around this collection and only allows read methods.
    The view is limited to a range from the lowIndex to the highIndex.
    A view is different from immutable collection (XGettingCollection.immure()) in the way, that changes in this collection are still affecting the view. The immutable collection on the other hand has no reference to this collection and changes therefore do not affect the immutable collection.
    
    Specified by:
    
    view in interface XGettingEnum<K>
    
    Specified by:
    
    view in interface XGettingSequence<K>
    
    Specified by:
    
    view in interface XProcessingSequence<K>
    
    Parameters:
    
    lowIndex - defines lower boundary for the view of the collection.
    
    highIndex - defines higher boundary for the view of the collection.
    
    Returns:
    
    new read-only collection to view a range of elements in this collection
  - toArray
```
public final K[] toArray(Class<K> type)
```
    Description copied from interface: XGettingCollection
    
    Returns a typed array containing all of the elements in this collection.
    The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
    This method acts as bridge between MicroStream-based collections and Java-native-based APIs.
    
    Specified by:
    
    toArray in interface XGettingCollection<K>
    
    Parameters:
    
    type - the Class representing type E at runtime.
    
    Returns:
    
    a typed array containing all of the elements in this collection
  - iterate
```
public final <P extends Consumer<? super K>> P iterate(P procedure)
```
    Description copied from interface: XIterable
    
    Executes the given procedure for each element of the XIterable until all elements have been processed or the action throws an exception. Unless otherwise specified by the implementing class, procedures are performed in the order of iteration (if an iteration order is specified). Exceptions thrown by the procedure are relayed to the caller.
    Should be identical to Iterable.forEach(Consumer).
    
    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>
    
    Type Parameters:
    
    P - type of procedure
    
    Parameters:
    
    procedure - The procedure to be performed for each element
    
    Returns:
    
    Given procedure
  - join
```
public final <A> A join(BiConsumer<? super K,? super A> joiner,
                        A aggregate)
```
    Description copied from interface: XJoinable
    
    Iterates over all elements of the collections and calls the joiner with each element and the aggregate.
    
    Specified by:
    
    join in interface XGettingCollection<K>
    
    Specified by:
    
    join in interface XJoinable<K>
    
    Type Parameters:
    
    A - type of aggregate
    
    Parameters:
    
    joiner - is the actual function to do the joining
    
    aggregate - where to join into
    
    Returns:
    
    the joined aggregate
  - count
```
public final long count(K element)
```
    Description copied from interface: XGettingCollection
    
    Count how many times this element matches another element in the collection using the Equalator.
    
    Specified by:
    
    count in interface XGettingCollection<K>
    
    Parameters:
    
    element - to count
    
    Returns:
    
    Amount of matches
  - countBy
```
public final long countBy(Predicate<? super K> predicate)
```
    Description copied from interface: XGettingCollection
    
    Count how many matches are found using the given predicate on each element of the collection.
    
    Specified by:
    
    countBy in interface XGettingCollection<K>
    
    Parameters:
    
    predicate - defines which elements are counted and which are not
    
    Returns:
    
    Amount of matches
  - 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>
    
    Parameters:
    
    sample - to seek in the collection
    
    Returns:
    
    the first contained element matching the passed sample
  - search
```
public final K search(Predicate<? super K> predicate)
```
    Description copied from interface: XGettingCollection
    
    Returns the first contained element matching the passed predicate.
    
    Specified by:
    
    search in interface XGettingCollection<K>
    
    Parameters:
    
    predicate - defines which element is searched
    
    Returns:
    
    Matching element
  - 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: ExtendedCollection
    
    Tells if this collection contains volatile elements.
    An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. Examples 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()
```
    Description copied from interface: ExtendedCollection
    
    Defines if null-elements are allowed inside the collection or not.
    
    Specified by:
    
    nullAllowed in interface ExtendedCollection<K>
    
    Returns:
    
    true if null is allowed inside the collection; false if not
  - 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)
```
    Description copied from interface: XGettingCollection
    
    Tests each element of the collection on the given predicate.
    
    Specified by:
    
    applies in interface XGettingCollection<K>
    
    Parameters:
    
    predicate - that's tested on each element.
    
    Returns:
    
    If all elements test successfully, true is returned. Otherwise (if at least one test has failed), false is returned.
  - nullContained
```
public final boolean nullContained()
```
    Specified by:
    
    nullContained in 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 exactly the given element.
  - contains
```
public final boolean contains(K element)
```
    Description copied from interface: XGettingCollection
    
    Checks if the given element is contained in the collection.
    In contrast to the XGettingCollection.containsId(Object) method, this method uses the internal Equalator defined by the collection itself.
    
    Specified by:
    
    contains in interface XGettingCollection<K>
    
    Parameters:
    
    element - to be searched in the collection
    
    Returns:
    
    Whether this collection contains the given element as specified by the Equalator.
  - containsAll
```
public final boolean containsAll(XGettingCollection<? extends K> elements)
```
    Specified by:
    
    containsAll in interface XGettingCollection<K>
    
    Parameters:
    
    elements - to be searched in the collection.
    
    Returns:
    
    Whether this collection contains all given elements as specified by the Equalator.
  - equals
```
public final boolean equals(XGettingCollection<? extends K> samples,
                            Equalator<? super K> equalator)
```
    Specified by:
    
    equals in interface XGettingCollection<K>
    
    Parameters:
    
    samples - is the collection which is checked for equality
    
    equalator - is used to check the equality of the collections
    
    Returns:
    
    true if the passed collection is of the same type as this collection and this.equalsContent(list, equalator) yields true
  - 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>
    
    Parameters:
    
    samples - is the collection which is checked for equality
    
    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)
```
    Description copied from interface: XGettingCollection
    Tests equality between each element of the two lists and calls Consumer.accept(Object) on the target Consumer for the equal elements.
    Therefore it effectively creates a mathematical intersection between the two collections.
    Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.
    Example:
```
 BulkList<Integer> collection1 = BulkList.New(1,2,3);
 BulkList<Integer> collection2 = BulkList.New(2,3,4);
 BulkList<Integer> intersection = collection1.intersect(collection2, Equalator.identity(), BulkList.New());
 
```
    Results in intersection containing 2 and 3.
    Specified by:
    
    intersect in interface XGettingCollection<K>
    
    Type Parameters:
    
    C - type of the target
    
    Parameters:
    
    other - collection to intersect with.
    
    equalator - which is used for the equal-tests.
    
    target - on which the Consumer.accept(Object) is called for equal elements.
    
    Returns:
    
    Given target
  - except
```
public final <C extends Consumer<? super K>> C except(XGettingCollection<? extends K> other,
                                                      Equalator<? super K> equalator,
                                                      C target)
```
    Description copied from interface: XGettingCollection
    Calls Consumer.accept(Object) on the target Consumer for each element of this collection that is not contained in the other collection (through the given equalator).
    Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.
    Example:
```
 BulkList<Integer> collection1 = BulkList.New(1,2,3);
 BulkList<Integer> collection2 = BulkList.New(2,3,4);
 BulkList<Integer> exceptCollection = collection1.except(collection2, Equalator.identity(), BulkList.New());
 
```
    Results in exceptCollection containing 1.
    Specified by:
    
    except in interface XGettingCollection<K>
    
    Type Parameters:
    
    C - type of the target
    
    Parameters:
    
    other - collection whose elements are excluded from the target.
    
    equalator - which is used for the equal-tests.
    
    target - on which the Consumer.accept(Object) is called for elements not contained in the other collection.
    
    Returns:
    
    Given target
  - union
```
public final <C extends Consumer<? super K>> C union(XGettingCollection<? extends K> other,
                                                     Equalator<? super K> equalator,
                                                     C target)
```
    Description copied from interface: XGettingCollection
    Calls Consumer.accept(Object) on the target Consumer for all the elements of this collection. And calls it for all elements of the other collection, that are not already in this collection (defined by the given Equalator)
    Therefore it effectively creates a mathematical union between the two collections.
    Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.
    Example:
```
 BulkList<Integer> collection1 = BulkList.New(1,2,3);
 BulkList<Integer> collection2 = BulkList.New(2,3,4);
 BulkList<Integer> union = collection1.union(collection2, Equalator.identity(), BulkList.New());
 
```
    Results in union containing 1, 2, 3 and 4.
    Specified by:
    
    union in interface XGettingCollection<K>
    
    Type Parameters:
    
    C - type of the target
    
    Parameters:
    
    other - collection to build a union with.
    
    equalator - which is used for the equal-tests.
    
    target - on which the Consumer.accept(Object) is called for all unified elements.
    
    Returns:
    
    Given target
  - copyTo
```
public final <C extends Consumer<? super K>> C copyTo(C target)
```
    Description copied from interface: XGettingCollection
    Calls Consumer.accept(Object) on the target Consumer for all the elements of this collection.
    Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.
    Example:
```
 BulkList<Integer> collection1 = BulkList.New(1,2,3);
 BulkList<Integer> copiedCollection = collection1.copyTo(BulkList.New());
 
```
    Results in copiedCollection containing 1, 2 and 3.
    Specified by:
    
    copyTo in interface XGettingCollection<K>
    
    Type Parameters:
    
    C - type of the target
    
    Parameters:
    
    target - on which the Consumer.accept(Object) is called for all elements of this collection.
    
    Returns:
    
    Given target
  - filterTo
```
public final <C extends Consumer<? super K>> C filterTo(C target,
                                                        Predicate<? super K> predicate)
```
    Description copied from interface: XGettingCollection
    Calls Consumer.accept(Object) on the target Consumer for all the elements of this collection which test true on the given predicate.
    Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.
    Example:
```
 BulkList<Integer> collection1 = BulkList.New(1,2,3);
 BulkList<Integer> filteredCollection = collection1.filterTo(BulkList.New(), e-> e % 2 == 0);
 
```
    Results in filteredCollection containing 2.
    Specified by:
    
    filterTo in interface XGettingCollection<K>
    
    Type Parameters:
    
    C - type of the target
    
    Parameters:
    
    target - on which the Consumer.accept(Object) is called for elements that test true.
    
    predicate - on which to test all elements.
    
    Returns:
    
    Given target
  - distinct
```
public final <C extends Consumer<? super K>> C distinct(C target)
```
    Description copied from interface: XGettingCollection
    
    Calls Consumer.accept(Object) on the target Consumer for all the unique/distinct elements of this collection. This means the elements are not equal to each other.
    Uniqueness is defined by the collections internal Equalator.
    Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.
    Example:
    BulkList<Integer> collection1 = BulkList.New(1,2,2,3); BulkList<Integer> distinctCollection = collection1.distinct(BulkList.New());
    Results in distinctCollection containing 1, 2 and 3.
    
    Specified by:
    
    distinct in interface XGettingCollection<K>
    
    Type Parameters:
    
    C - type of the target
    
    Parameters:
    
    target - on which the Consumer.accept(Object) is called for every distinct element of this collection.
    
    Returns:
    
    Given target
  - distinct
```
public final <C extends Consumer<? super K>> C distinct(C target,
                                                        Equalator<? super K> equalator)
```
    Description copied from interface: XGettingCollection
    Calls Consumer.accept(Object) on the target Consumer for all the unique/distinct elements of this collection. This means the elements are not equal to each other.
    Uniqueness is defined by the given Equalator.
    Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.
    Example:
```
 BulkList<Integer> collection1 = BulkList.New(1,2,2,3);
 BulkList<Integer> distinctCollection = collection1.distinct(BulkList.New(), Equalator.identity());
 
```
    Results in distinctCollection containing 1, 2 and 3.
    Specified by:
    
    distinct in interface XGettingCollection<K>
    
    Type Parameters:
    
    C - type of the target
    
    Parameters:
    
    target - on which the Consumer.accept(Object) is called for every distinct element of this collection.
    
    equalator - defines what distinct means (which elements are equal to one another)
    
    Returns:
    
    Given target
  - 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()
```
    Specified by:
    
    isFull in interface CapacityCarrying
    
    Returns:
    
    true if the current capacity cannot be increased any more.
  - 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
    
    Parameters:
    
    requiredFreeCapacity - the capacity to ensure
    
    Returns:
    
    this
  - 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)
```
    Description copied from interface: XAddingCollection
    
    Adds the passed element.
    
    Specified by:
    
    add in interface XAddingCollection<K>
    
    Parameters:
    
    element - to add
    
    Returns:
    
    true if element was added; false if not
  - 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)
```
    Description copied from interface: XPuttingCollection
    
    Adds the specified element to this collection if it is not already present (optional operation).
    
    Specified by:
    
    put in interface XPuttingCollection<K>
    
    Parameters:
    
    element - to add
    
    Returns:
    
    true if this collection did not already contain the specified element
  - 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)
```
    Description copied from interface: XPuttingCollection
    
    Adds the specified elements to this collection if it is not already present (optional operation).
    
    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>
    
    Parameters:
    
    elements - to add
    
    Returns:
    
    this
  - putAll
```
public final EqHashTable.Keys putAll(K[] elements,
                                     int srcIndex,
                                     int srcLength)
```
    Description copied from interface: XPuttingCollection
    
    Adds the specified elements to this collection if it is not already present (optional operation).
    Only the elements with indizes from the srcStartIndex to the srcStartIndex+srcLength are put in the collection.
    
    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>
    
    Parameters:
    
    elements - to add
    
    srcIndex - start index of elements-array to add to collection
    
    srcLength - length of elements-array to add to collection
    
    Returns:
    
    this
  - putAll
```
public final EqHashTable.Keys putAll(XGettingCollection<? extends K> elements)
```
    Description copied from interface: XPuttingCollection
    
    Adds the specified elements to this collection if it is not already present (optional operation).
    
    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>
    
    Parameters:
    
    elements - to add
    
    Returns:
    
    this
  - 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: ConsolidatableCollection
    
    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).
    
    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)
```
    Description copied from interface: XRemovingCollection
    
    Removing all elements except the ones contained in the given elements-collection.
    Basically intersect this collection with the given collection and only keeping the resulting elements.
    
    Specified by:
    
    retainAll in interface XRemovingCollection<K>
    
    Parameters:
    
    elements - to retain
    
    Returns:
    
    Amount of deleted elements
  - 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()
```
    Description copied from interface: XGettingSequence
    
    Creates a new XGettingSequence with the reversed order of elements.
    This method creates a new collection and does not change the existing collection.
    
    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>
    
    Returns:
    
    New copy of the collection
  - copySelection
```
public final <T extends Consumer<? super K>> T copySelection(T target,
                                                             long... indices)
```
    Description copied from interface: XGettingSequence
    
    Iterates through all the elements of the given indices and calls the Consumer.accept(Object) on the target Consumer.
    
    Specified by:
    
    copySelection in interface XGettingSequence<K>
    
    Type Parameters:
    
    T - type of the target
    
    Parameters:
    
    target - on which the Consumer.accept(Object) is called
    
    indices - of the elements which are copied
    
    Returns:
    
    Given target
  - iterateIndexed
```
public final <P extends IndexedAcceptor<? super K>> P iterateIndexed(P procedure)
```
    Description copied from interface: XIndexIterable
    
    Iterates over elements with the IndexedAcceptor to use not only the element itself but also its coherent index.
    
    Specified by:
    
    iterateIndexed in interface XIndexIterable<K>
    
    Type Parameters:
    
    P - type of procedure
    
    Parameters:
    
    procedure - which is executed when iterating
    
    Returns:
    
    Given procedure
  - 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()
```
    Description copied from interface: XGettingSequence
    
    Gets first element or throws IndexOutOfBoundsException if the collection is empty.
    Is an alias for XGettingSequence.get().
    
    Specified by:
    
    first in interface XGettingSequence<K>
    
    Returns:
    
    First element
  - last
```
public final K last()
```
    Description copied from interface: XGettingSequence
    
    Gets last element or throws IndexOutOfBoundsException if the collection is empty.
    
    Specified by:
    
    last in interface XGettingSequence<K>
    
    Returns:
    
    Last element
  - poll
```
public final K poll()
```
    Description copied from interface: XGettingSequence
    
    Gets first element or null if the collection is empty.
    
    Specified by:
    
    poll in interface XGettingSequence<K>
    
    Returns:
    
    First element or null
  - peek
```
public final K peek()
```
    Description copied from interface: XGettingSequence
    
    Gets last element or null if the collection is empty.
    This behaves like peeking on a stack without pop.
    
    Specified by:
    
    peek in interface XGettingSequence<K>
    
    Returns:
    
    Last element or null
  - indexOf
```
public final long indexOf(K element)
```
    Specified by:
    
    indexOf in interface XGettingSequence<K>
  - indexBy
```
public final long indexBy(Predicate<? super K> predicate)
```
    Description copied from interface: XGettingSequence
    
    Iterates forwards through the collection and returns the index of the first element that the passed {link Predicate} applies to immediately.
    Stops iterating on the first element that the predicate applies to.
    Basically the opposite of XGettingSequence.lastIndexBy(Predicate)
    
    Specified by:
    
    indexBy in interface XGettingSequence<K>
    
    Parameters:
    
    predicate - to define a valid element
    
    Returns:
    
    The index of the first positively tested element.
  - isSorted
```
public final boolean isSorted(Comparator<? super K> comparator)
```
    Description copied from interface: XGettingSequence
    
    Tests if the collection is sorted according to the given comparator.
    
    Specified by:
    
    isSorted in interface XGettingSequence<K>
    
    Parameters:
    
    comparator - defines if elements are sorted
    
    Returns:
    
    true if it sorted, false if not
  - lastIndexOf
```
public final long lastIndexOf(K element)
```
    Specified by:
    
    lastIndexOf in interface XGettingSequence<K>
  - lastIndexBy
```
public final long lastIndexBy(Predicate<? super K> predicate)
```
    Description copied from interface: XGettingSequence
    
    Iterates backwards through the collection and returns the index of the last element that the passed Predicate applies to immediately.
    Stops iterating on the first element that the predicate applies to.
    Basically the opposite of XGettingSequence.indexBy(Predicate).
    Similar but not the same as XGettingSequence.scan(Predicate), since scan iterates through all elements.
    
    Specified by:
    
    lastIndexBy in interface XGettingSequence<K>
    
    Parameters:
    
    predicate - to define a valid element
    
    Returns:
    
    the index of the last positively tested element.
  - 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 Predicate applied to ("scanning").
    In order to find the last element, this method must iterate over all elements of the collection (opposed to XGettingSequence.indexBy(Predicate) and XGettingSequence.lastIndexBy(Predicate)).
    Iteration can be safely canceled with a ThrowBreak (X.BREAK)
    
    Specified by:
    
    scan in interface XGettingSequence<K>
    
    Parameters:
    
    predicate - to define a valid element
    
    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)
```
    Description copied from interface: XRemovingSequence
    
    Removing all elements but the ones from the offset (basically start index) to the offset+length (end index).
    
    Specified by:
    
    retainRange in interface XRemovingSequence<K>
    
    Parameters:
    
    startIndex - is the index of the first element to retain
    
    length - is the amount of elements to retain
    
    Returns:
    
    this
  - 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()
```
    Description copied from interface: XGettingCollection
    
    Returns an array containing all of the elements in this collection.
    The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
    This method acts as bridge between MicroStream-based collections and Java-native-based APIs.
    
    Specified by:
    
    toArray in interface XGettingCollection<K>
    
    Returns:
    
    an array containing all of the elements in this collection
  - 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 XRemovingCollection<K>
    
    Specified by:
    
    clear in interface Clearable
    
    See Also:
    
    XRemovingCollection.clear()
  - reverse
```
public final EqHashTable.Keys reverse()
```
    Description copied from interface: XSortableSequence
    
    Reverses the order of its own elements and returns itself.
    Unlike the XSortableSequence.toReversed() method, this method does not create a new collection, but changes the order of its own elements.
    
    Specified by:
    
    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>
    
    Returns:
    
    this
  - sort
```
public final EqHashTable.Keys sort(Comparator<? super K> comparator)
```
    Description copied from interface: Sortable
    
    Sorts this collection according to the given comparator and returns itself.
    
    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>
    
    Parameters:
    
    comparator - to sort this collection
    
    Returns:
    
    this
  - shiftTo
```
public final EqHashTable.Keys shiftTo(long sourceIndex,
                                      long targetIndex)
```
    Description copied from interface: XOrderingSequence
    
    Moves the element from the sourceIndex in the sequence to the targetIndex.
    All other elements are possibly moved to create the empty slot for the shifting element.
    Does not expand or shrink the capacity of the sequence.
    Throws a IndexExceededException if sourceIndex or targetIndex are greater than the size of the sequence.
    
    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>
    
    Parameters:
    
    sourceIndex - points to the source element; Index of the source element
    
    targetIndex - points to the target element; Index of the target element
    
    Returns:
    
    this
  - shiftTo
```
public final EqHashTable.Keys shiftTo(long sourceIndex,
                                      long targetIndex,
                                      long length)
```
    Description copied from interface: XOrderingSequence
    
    Moves multiple elements from the sourceIndex in the sequence to the targetIndex.
    All other elements are possibly moved to create the empty slot for the shifting element.
    Does not expand or shrink the capacity of the sequence.
    Throws a IndexExceededException if sourceIndex or targetIndex exceed the size of the sequence.
    
    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>
    
    Parameters:
    
    sourceIndex - points to the source element; Index of the source element
    
    targetIndex - points to the target element; Index of the target element
    
    length - Amount of moved elements.
    
    Returns:
    
    self
  - shiftBy
```
public final EqHashTable.Keys shiftBy(long sourceIndex,
                                      long distance)
```
    Description copied from interface: XOrderingSequence
    
    Moves the element from the sourceIndex in the sequence to a higher index position.
    All other elements are possibly moved to create the empty slot for the shifting element. ("to the right")
    Does not expand or shrink the capacity of the sequence.
    Throws a IndexExceededException if sourceIndex or targetIndex (sourceIndex+distance) exceed the size of the sequence.
    
    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>
    
    Parameters:
    
    sourceIndex - points to the source element; Index of the source element
    
    distance - of how far the element should be moved. Example: 1 moves the element from position 21 to position 22
    
    Returns:
    
    self
  - shiftBy
```
public final EqHashTable.Keys shiftBy(long sourceIndex,
                                      long distance,
                                      long length)
```
    Description copied from interface: XOrderingSequence
    
    Moves multiple elements from the sourceIndex in the sequence to a higher index position.
    All other elements are possibly moved to create the empty slot for the shifting elements. ("to the right")
    Does not expand or shrink the capacity of the sequence.
    Throws a IndexExceededException if sourceIndex or targetIndex (sourceIndex+distance+length) exceed the size of the sequence.
    
    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>
    
    Parameters:
    
    sourceIndex - points to the source element; Index of the source element
    
    distance - of how far the element should be moved. Example: 1 moves the element from position 21 to position 22
    
    length - Amount of moved elements.
    
    Returns:
    
    self
  - 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.collections.types.XEnum

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

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

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.interfaces.HashCollection

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.types.XCollection

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

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

Methods inherited from interface java.util.function.Consumer

Methods inherited from interface one.microstream.collections.sorting.SortableProcedure

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

ensureFreeCapacity

ensureCapacity

nullAdd

add

addAll

addAll

addAll

nullPut

accept

put

addGet

deduplicate

putGet

replace

putAll

putAll

putAll

truncate