LockedMap (MicroStream API)

java.lang.Object
- one.microstream.collections.LockedMap<K,V>

All Implemented Interfaces:

Iterable<KeyValue<K,V>>, Consumer<KeyValue<K,V>>, CapacityCarrying, CapacityExtendable, ConsolidatableCollection, ExtendedCollection<KeyValue<K,V>>, ExtendedMap<K,V>, OptimizableCollection, ReleasingCollection<KeyValue<K,V>>, Sized, Truncateable, XAddGetCollection<KeyValue<K,V>>, XAddGetMap<K,V>, XAddGetSet<KeyValue<K,V>>, XAddingCollection<KeyValue<K,V>>, XAddingMap<K,V>, XAddingSet<KeyValue<K,V>>, XCollection<KeyValue<K,V>>, XGettingCollection<KeyValue<K,V>>, XGettingMap<K,V>, XGettingSet<KeyValue<K,V>>, XIterable<KeyValue<K,V>>, XJoinable<KeyValue<K,V>>, XMap<K,V>, XProcessingCollection<KeyValue<K,V>>, XProcessingMap<K,V>, XProcessingSet<KeyValue<K,V>>, XPutGetCollection<KeyValue<K,V>>, XPutGetMap<K,V>, XPutGetSet<KeyValue<K,V>>, XPuttingCollection<KeyValue<K,V>>, XPuttingMap<K,V>, XPuttingSet<KeyValue<K,V>>, XRemovingCollection<KeyValue<K,V>>, XRemovingMap<K,V>, XRemovingSet<KeyValue<K,V>>, XSet<KeyValue<K,V>>, Synchronized, ThreadSafe, Processable<KeyValue<K,V>>, Clearable, Copyable
```
public final class LockedMap<K,V>
extends Object
implements XMap<K,V>, Synchronized
```

Nested Class Summary
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XMap
  XMap.Bridge<K,V>, XMap.Creator<K,V>, XMap.EntriesBridge<K,V>, XMap.Keys<K,V>, XMap.Satellite<K,V>, XMap.Values<K,V>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XRemovingMap
  XRemovingMap.Factory<K,V>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XSet
  XSet.Factory<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable
  XIterable.Executor<E>
- Nested classes/interfaces inherited from interface one.microstream.typing.Copyable
  Copyable.Static

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`accept(KeyValue<K,V> element)`
`boolean`	`add(KeyValue<K,V> element)` Adds the passed element.
`boolean`	`add(K key, V value)` Adds the passed key and value as an entry if key is not yet contained.
`XMap<K,V>`	`addAll(KeyValue<K,V>... elements)`
`XMap<K,V>`	`addAll(KeyValue<K,V>[] elements, int srcStartIndex, int srcLength)`
`XMap<K,V>`	`addAll(XGettingCollection<? extends KeyValue<K,V>> elements)`
`KeyValue<K,V>`	`addGet(KeyValue<K,V> element)`
`KeyValue<K,V>`	`addGet(K key, V value)`
`boolean`	`applies(Predicate<? super KeyValue<K,V>> predicate)` Tests each element of the collection on the given predicate.
`void`	`clear()` Clears all elements from the collection while leaving the capacity as it is.
`Aggregator<KeyValue<K,V>,? extends XCollection<KeyValue<K,V>>>`	`collector()`
`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(KeyValue<K,V> element)` Checks if the given element is contained in the collection.
`boolean`	`containsAll(XGettingCollection<? extends KeyValue<K,V>> elements)`
`boolean`	`containsId(KeyValue<K,V> 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 KeyValue<K,V>> predicate)`
`XMap<K,V>`	`copy()` Creates a true copy of this collection which references the same elements as this collection does at the time the method is called.
`<T extends Consumer<? super KeyValue<K,V>>> T`	`copyTo(T target)` Calls `Consumer.accept(Object)` on the target `Consumer` for all the elements of this collection.
`long`	`count(KeyValue<K,V> element)` Count how many times this element matches another element in the collection using the `Equalator`.
`long`	`countBy(Predicate<? super KeyValue<K,V>> 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.
`long`	`currentFreeCapacity()`
`KeyValue<K,V>`	`deduplicate(KeyValue<K,V> element)`
`<T extends Consumer<? super KeyValue<K,V>>> T`	`distinct(T target)` Calls `Consumer.accept(Object)` on the target `Consumer` for all the unique/distinct elements of this collection.
`<T extends Consumer<? super KeyValue<K,V>>> T`	`distinct(T target, Equalator<? super KeyValue<K,V>> equalator)` Calls `Consumer.accept(Object)` on the target `Consumer` for all the unique/distinct elements of this collection.
`V`	`ensure(K key, Function<? super K,V> valueProvider)` Ensures that this map instance contains a non-null value for the passed key and returns that value.
`CapacityExtendable`	`ensureCapacity(long minimalCapacity)`
`CapacityExtendable`	`ensureFreeCapacity(long minimalFreeCapacity)` 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 KeyValue<K,V>>`	`equality()`
`boolean`	`equals(Object o)` Deprecated.
`boolean`	`equals(XGettingCollection<? extends KeyValue<K,V>> samples, Equalator<? super KeyValue<K,V>> equalator)`
`boolean`	`equalsContent(XGettingCollection<? extends KeyValue<K,V>> samples, Equalator<? super KeyValue<K,V>> equalator)` Returns `true` if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.
`<T extends Consumer<? super KeyValue<K,V>>> T`	`except(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> equalator, T 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).
`KeyValue<K,V>`	`fetch()`
`<T extends Consumer<? super KeyValue<K,V>>> T`	`filterTo(T target, Predicate<? super KeyValue<K,V>> predicate)` Calls `Consumer.accept(Object)` on the target `Consumer` for all the elements of this collection which test `true` on the given predicate.
`void`	`forEach(Consumer<? super KeyValue<K,V>> action)`
`KeyValue<K,V>`	`get()` Gets one element from the collection.
`V`	`get(K key)`
`int`	`hashCode()` Deprecated.
`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.
`XImmutableMap<K,V>`	`immure()` Provides an instance of an immutable collection type with equal behavior and data as this instance.
`<T extends Consumer<? super KeyValue<K,V>>> T`	`intersect(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> equalator, T 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()`
`<P extends Consumer<? super KeyValue<K,V>>> 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.
`Iterator<KeyValue<K,V>>`	`iterator()`
`<A> A`	`join(BiConsumer<? super KeyValue<K,V>,? super A> joiner, A aggregate)` Iterates over all elements of the collections and calls the joiner with each element and the aggregate.
`XMap.Keys<K,V>`	`keys()`
`KeyValue<K,V>`	`lookup(K key)`
`KeyValue<K,V>`	`max(Comparator<? super KeyValue<K,V>> 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.
`KeyValue<K,V>`	`min(Comparator<? super KeyValue<K,V>> comparator)`
`<C extends Consumer<? super KeyValue<K,V>>> C`	`moveTo(C target, Predicate<? super KeyValue<K,V>> predicate)`
`static <K,V> LockedMap<K,V>`	`New(XMap<K,V> subject)`
`static <K,V> LockedMap<K,V>`	`New(XMap<K,V> subject, Object lock)`
`boolean`	`nullAdd()`
`boolean`	`nullAllowed()` Defines if null-elements are allowed inside the collection or not.
`boolean`	`nullContained()`
`boolean`	`nullKeyAllowed()`
`boolean`	`nullPut()`
`long`	`nullRemove()`
`boolean`	`nullValuesAllowed()`
`XMap.EntriesBridge<K,V>`	`old()`
`XMap.Bridge<K,V>`	`oldMap()`
`long`	`optimize()` Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.
`KeyValue<K,V>`	`pinch()`
`<P extends Consumer<? super KeyValue<K,V>>> P`	`process(P processor)`
`boolean`	`put(KeyValue<K,V> element)` Adds the specified element to this collection if it is not already present (optional operation).
`boolean`	`put(K key, V value)` Ensures the passed key and value to be contained as an entry in the map.
`XMap<K,V>`	`putAll(KeyValue<K,V>... elements)` Ensures the passed key-value-pairs to be contained as entries in the map.
`XMap<K,V>`	`putAll(KeyValue<K,V>[] elements, int srcStartIndex, int srcLength)` Ensures the passed key-value-pairs to be contained as entries in the map.
`XSet<KeyValue<K,V>>`	`putAll(XGettingCollection<? extends KeyValue<K,V>> elements)` Adds the specified elements to this collection if it is not already present (optional operation).
`KeyValue<K,V>`	`putGet(KeyValue<K,V> element)`
`KeyValue<K,V>`	`putGet(K key, V value)` Ensures the passed key and value to be contained as an entry in the map.
`<C extends Consumer<? super V>> C`	`query(XIterable<? extends K> keys, C collector)`
`long`	`remainingCapacity()`
`long`	`remove(KeyValue<K,V> element)`
`long`	`removeAll(XGettingCollection<? extends KeyValue<K,V>> elements)`
`long`	`removeBy(Predicate<? super KeyValue<K,V>> predicate)`
`long`	`removeDuplicates()`
`long`	`removeDuplicates(Equalator<? super KeyValue<K,V>> equalator)`
`V`	`removeFor(K key)`
`boolean`	`removeOne(KeyValue<K,V> element)`
`KeyValue<K,V>`	`replace(KeyValue<K,V> element)`
`KeyValue<K,V>`	`replace(K key, V value)`
`long`	`retainAll(XGettingCollection<? extends KeyValue<K,V>> elements)` Removing all elements except the ones contained in the given elements-collection.
`KeyValue<K,V>`	`retrieve(KeyValue<K,V> element)`
`KeyValue<K,V>`	`retrieveBy(Predicate<? super KeyValue<K,V>> predicate)`
`KeyValue<K,V>`	`search(Predicate<? super KeyValue<K,V>> predicate)` Returns the first contained element matching the passed predicate.
`V`	`searchValue(Predicate<? super K> keyPredicate)`
`KeyValue<K,V>`	`seek(KeyValue<K,V> sample)` Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained.
`boolean`	`set(K key, V value)` Sets the passed key and value to an appropriate entry if one can be found.
`KeyValue<K,V>`	`setGet(K key, V value)` Sets the passed key and value to an appropriate entry if one can be found.
`long`	`size()`
`Spliterator<KeyValue<K,V>>`	`spliterator()`
`KeyValue<K,V>`	`substitute(K key, V value)`
`Object[]`	`toArray()` Returns an array containing all of the elements in this collection.
`KeyValue<K,V>[]`	`toArray(Class<KeyValue<K,V>> type)` Returns a typed array containing all of the elements in this collection.
`void`	`truncate()` Clears (and reinitializes if needed) this collection in the fastest possible way, i.e.
`<T extends Consumer<? super KeyValue<K,V>>> T`	`union(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> equalator, T target)` Calls `Consumer.accept(Object)` on the target `Consumer` for all the elements of this collection.
`boolean`	`valuePut(K sampleKey, V value)` Ensures the passed value to be either set to an existing entry equal to sampleKey or inserted as a new one.
`V`	`valuePutGet(K sampleKey, V value)` Ensures the passed value to be either set to an existing entry appropriate to sampleKey or inserted as a new one.
`XMap.Values<K,V>`	`values()`
`boolean`	`valueSet(K sampleKey, V value)` Sets only the passed value to an existing entry appropriate to the passed sampleKey.
`V`	`valueSetGet(K sampleKey, V value)` Sets only the passed value to an existing entry appropriate to the passed sampleKey.
`XGettingMap<K,V>`	`view()` Creates a view of this collection and returns it.

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

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

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

- Method Detail
  - New
```
public static <K,V> LockedMap<K,V> New(XMap<K,V> subject)
```
  - New
```
public static <K,V> LockedMap<K,V> New(XMap<K,V> subject,
                                       Object lock)
```
  - 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.
  - process
```
public final <P extends Consumer<? super KeyValue<K,V>>> P process(P processor)
```
    Specified by:
    
    process in interface Processable<KeyValue<K,V>>
  - clear
```
public final void clear()
```
    Description copied from interface: XRemovingCollection
    
    Clears all elements from the collection while leaving the capacity as it is.
    
    Specified by:
    
    clear in interface XRemovingCollection<KeyValue<K,V>>
    
    Specified by:
    
    clear in interface Clearable
  - join
```
public final <A> A join(BiConsumer<? super KeyValue<K,V>,? 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<KeyValue<K,V>>
    
    Specified by:
    
    join in interface XJoinable<KeyValue<K,V>>
    
    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
  - 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<KeyValue<K,V>>
    
    Returns:
    
    true if null is allowed inside the collection; false if not
  - optimize
```
public final long optimize()
```
    Description copied from interface: OptimizableCollection
    
    Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.
    
    Specified by:
    
    optimize in interface OptimizableCollection
    
    Specified by:
    
    optimize in interface XRemovingCollection<KeyValue<K,V>>
    
    Returns:
    
    the storage size of the collection after the optimzation.
  - 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<KeyValue<K,V>>
    
    Returns:
    
    the number of discarded entries.
  - truncate
```
public final void truncate()
```
    Description copied from interface: XRemovingCollection
    
    Clears (and reinitializes if needed) this collection in the fastest possible way, i.e. by allocating a new and empty internal storage of default capacity. The collection will be empty after calling this method.
    
    Specified by:
    
    truncate in interface Truncateable
    
    Specified by:
    
    truncate in interface XRemovingCollection<KeyValue<K,V>>
  - removeFor
```
public final V removeFor(K key)
```
    Specified by:
    
    removeFor in interface XProcessingMap<K,V>
  - addGet
```
public final KeyValue<K,V> addGet(KeyValue<K,V> element)
```
    Specified by:
    
    addGet in interface XAddGetSet<KeyValue<K,V>>
  - deduplicate
```
public final KeyValue<K,V> deduplicate(KeyValue<K,V> element)
```
    Specified by:
    
    deduplicate in interface XAddGetSet<KeyValue<K,V>>
  - putGet
```
public final KeyValue<K,V> putGet(KeyValue<K,V> element)
```
    Specified by:
    
    putGet in interface XPutGetSet<KeyValue<K,V>>
  - replace
```
public final KeyValue<K,V> replace(KeyValue<K,V> element)
```
    Specified by:
    
    replace in interface XPutGetSet<KeyValue<K,V>>
  - addGet
```
public final KeyValue<K,V> addGet(K key,
                                  V value)
```
    Specified by:
    
    addGet in interface XAddGetMap<K,V>
  - substitute
```
public KeyValue<K,V> substitute(K key,
                                V value)
```
    Specified by:
    
    substitute in interface XAddGetMap<K,V>
  - replace
```
public KeyValue<K,V> replace(K key,
                             V value)
```
    Specified by:
    
    replace in interface XPutGetMap<K,V>
  - 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<KeyValue<K,V>>
    
    Specified by:
    
    hasVolatileElements in interface XGettingCollection<KeyValue<K,V>>
    
    Returns:
    
    true if the collection contains volatile elements.
  - keys
```
public final XMap.Keys<K,V> keys()
```
    Specified by:
    
    keys in interface XGettingMap<K,V>
    
    Specified by:
    
    keys in interface XMap<K,V>
    
    Specified by:
    
    keys in interface XProcessingMap<K,V>
  - ensure
```
public final V ensure(K key,
                      Function<? super K,V> valueProvider)
```
    Description copied from interface: XAddGetMap
    
    Ensures that this map instance contains a non-null value for the passed key and returns that value.
    If a non-null value can be found for the passed key, it is returned. Otherwise, the value provided by the passed supplier will be associated with the passed key and is returned.
    
    Specified by:
    
    ensure in interface XAddGetMap<K,V>
    
    Parameters:
    
    key - the search key.
    
    valueProvider - the value supplier used to provide a value for the passed key in case non could be found.
    
    Returns:
    
    the value associated with the passed key, either already existing or newly assiciated by the call of this method.
  - iterate
```
public final <P extends Consumer<? super KeyValue<K,V>>> 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 XGettingSet<KeyValue<K,V>>
    
    Specified by:
    
    iterate in interface XIterable<KeyValue<K,V>>
    
    Specified by:
    
    iterate in interface XProcessingCollection<KeyValue<K,V>>
    
    Type Parameters:
    
    P - type of procedure
    
    Parameters:
    
    procedure - The procedure to be performed for each element
    
    Returns:
    
    Given procedure
  - collector
```
public final Aggregator<KeyValue<K,V>,? extends XCollection<KeyValue<K,V>>> collector()
```
    Specified by:
    
    collector in interface XAddingCollection<KeyValue<K,V>>
    
    Specified by:
    
    collector in interface XCollection<KeyValue<K,V>>
  - putAll
```
public final XSet<KeyValue<K,V>> putAll(XGettingCollection<? extends KeyValue<K,V>> 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 XCollection<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XPutGetCollection<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XPutGetSet<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XPuttingCollection<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XPuttingSet<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XSet<KeyValue<K,V>>
    
    Parameters:
    
    elements - to add
    
    Returns:
    
    this
  - values
```
public final XMap.Values<K,V> values()
```
    Specified by:
    
    values in interface XGettingMap<K,V>
    
    Specified by:
    
    values in interface XMap<K,V>
    
    Specified by:
    
    values in interface XProcessingMap<K,V>
  - ensureCapacity
```
public final CapacityExtendable ensureCapacity(long minimalCapacity)
```
    Specified by:
    
    ensureCapacity in interface CapacityExtendable
  - remainingCapacity
```
public final long remainingCapacity()
```
    Specified by:
    
    remainingCapacity in interface CapacityCarrying
    
    Returns:
    
    the amount of elements this carrier instance can collect before reaching its maximimum capacity.
  - old
```
public final XMap.EntriesBridge<K,V> old()
```
    Specified by:
    
    old in interface XGettingCollection<KeyValue<K,V>>
    
    Specified by:
    
    old in interface XGettingMap<K,V>
    
    Specified by:
    
    old in interface XMap<K,V>
  - oldMap
```
public final XMap.Bridge<K,V> oldMap()
```
    Specified by:
    
    oldMap in interface XGettingMap<K,V>
    
    Specified by:
    
    oldMap in interface XMap<K,V>
  - ensureFreeCapacity
```
public final CapacityExtendable ensureFreeCapacity(long minimalFreeCapacity)
```
    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:
    
    minimalFreeCapacity - the capacity to ensure
    
    Returns:
    
    this
  - copy
```
public final XMap<K,V> 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<KeyValue<K,V>>
    
    Specified by:
    
    copy in interface XAddGetSet<KeyValue<K,V>>
    
    Specified by:
    
    copy in interface XCollection<KeyValue<K,V>>
    
    Specified by:
    
    copy in interface XGettingCollection<KeyValue<K,V>>
    
    Specified by:
    
    copy in interface XGettingMap<K,V>
    
    Specified by:
    
    copy in interface XGettingSet<KeyValue<K,V>>
    
    Specified by:
    
    copy in interface XMap<K,V>
    
    Specified by:
    
    copy in interface XProcessingMap<K,V>
    
    Specified by:
    
    copy in interface XProcessingSet<KeyValue<K,V>>
    
    Specified by:
    
    copy in interface XPutGetCollection<KeyValue<K,V>>
    
    Specified by:
    
    copy in interface XPutGetSet<KeyValue<K,V>>
    
    Specified by:
    
    copy in interface XSet<KeyValue<K,V>>
    
    Specified by:
    
    copy in interface Copyable
    
    Returns:
    
    a copy of this list
  - query
```
public final <C extends Consumer<? super V>> C query(XIterable<? extends K> keys,
                                                     C collector)
```
    Specified by:
    
    query in interface XGettingMap<K,V>
  - put
```
public final boolean put(KeyValue<K,V> 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<KeyValue<K,V>>
    
    Parameters:
    
    element - to add
    
    Returns:
    
    true if this collection did not already contain the specified element
  - nullKeyAllowed
```
public final boolean nullKeyAllowed()
```
    Specified by:
    
    nullKeyAllowed in interface XAddingMap<K,V>
    
    Specified by:
    
    nullKeyAllowed in interface XGettingMap<K,V>
    
    Specified by:
    
    nullKeyAllowed in interface XMap<K,V>
  - nullPut
```
public final boolean nullPut()
```
    Specified by:
    
    nullPut in interface XPuttingCollection<KeyValue<K,V>>
  - isFull
```
public final boolean isFull()
```
    Specified by:
    
    isFull in interface CapacityCarrying
    
    Returns:
    
    true if the current capacity cannot be increased any more.
  - nullValuesAllowed
```
public final boolean nullValuesAllowed()
```
    Specified by:
    
    nullValuesAllowed in interface XAddingMap<K,V>
    
    Specified by:
    
    nullValuesAllowed in interface XGettingMap<K,V>
    
    Specified by:
    
    nullValuesAllowed in interface XMap<K,V>
  - 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.
  - get
```
public final KeyValue<K,V> 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<KeyValue<K,V>>
    
    Returns:
    
    the first / any element.
  - add
```
public final boolean add(K key,
                         V value)
```
    Description copied from interface: XMap
    
    Adds the passed key and value as an entry if key is not yet contained. Return value indicates new entry.
    
    Specified by:
    
    add in interface XAddingMap<K,V>
    
    Specified by:
    
    add in interface XMap<K,V>
    
    Parameters:
    
    key - to add
    
    value - to add
    
    Returns:
    
    true if element was added; false if not
  - fetch
```
public final KeyValue<K,V> fetch()
```
    Specified by:
    
    fetch in interface XProcessingCollection<KeyValue<K,V>>
  - view
```
public final XGettingMap<K,V> 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<KeyValue<K,V>>
    
    Specified by:
    
    view in interface XGettingMap<K,V>
    
    Returns:
    
    new read-only collection to view this collection
  - forEach
```
public final void forEach(Consumer<? super KeyValue<K,V>> action)
```
    Specified by:
    
    forEach in interface Iterable<KeyValue<K,V>>
  - pinch
```
public final KeyValue<K,V> pinch()
```
    Specified by:
    
    pinch in interface XProcessingCollection<KeyValue<K,V>>
  - put
```
public final boolean put(K key,
                         V value)
```
    Description copied from interface: XMap
    
    Ensures the passed key and value to be contained as an entry in the map.
    
    Specified by:
    
    put in interface XMap<K,V>
    
    Specified by:
    
    put in interface XPuttingMap<K,V>
    
    Parameters:
    
    key - to add
    
    value - to add
    
    Returns:
    
    true if element was added; false if not
  - iterator
```
public final Iterator<KeyValue<K,V>> iterator()
```
    Specified by:
    
    iterator in interface Iterable<KeyValue<K,V>>
    
    Specified by:
    
    iterator in interface XGettingCollection<KeyValue<K,V>>
  - 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<KeyValue<K,V>>
    
    Returns:
    
    an array containing all of the elements in this collection
  - toArray
```
public final KeyValue<K,V>[] toArray(Class<KeyValue<K,V>> 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<KeyValue<K,V>>
    
    Parameters:
    
    type - the Class representing type E at runtime.
    
    Returns:
    
    a typed array containing all of the elements in this collection
  - retrieve
```
public final KeyValue<K,V> retrieve(KeyValue<K,V> element)
```
    Specified by:
    
    retrieve in interface XProcessingCollection<KeyValue<K,V>>
  - retrieveBy
```
public final KeyValue<K,V> retrieveBy(Predicate<? super KeyValue<K,V>> predicate)
```
    Specified by:
    
    retrieveBy in interface XProcessingCollection<KeyValue<K,V>>
  - currentFreeCapacity
```
public final long currentFreeCapacity()
```
    Specified by:
    
    currentFreeCapacity in interface CapacityExtendable
  - set
```
public final boolean set(K key,
                         V value)
```
    Description copied from interface: XMap
    
    Sets the passed key and value to an appropriate entry if one can be found.
    
    Specified by:
    
    set in interface XAddingMap<K,V>
    
    Specified by:
    
    set in interface XMap<K,V>
    
    Parameters:
    
    key - to find element to change
    
    value - to set
    
    Returns:
    
    true if element was changed; false if not
  - removeDuplicates
```
public final long removeDuplicates(Equalator<? super KeyValue<K,V>> equalator)
```
    Specified by:
    
    removeDuplicates in interface XProcessingCollection<KeyValue<K,V>>
  - accept
```
public final void accept(KeyValue<K,V> element)
```
    Specified by:
    
    accept in interface Consumer<KeyValue<K,V>>
    
    Specified by:
    
    accept in interface XAddingCollection<KeyValue<K,V>>
  - removeBy
```
public final long removeBy(Predicate<? super KeyValue<K,V>> predicate)
```
    Specified by:
    
    removeBy in interface XProcessingCollection<KeyValue<K,V>>
  - add
```
public final boolean add(KeyValue<K,V> element)
```
    Description copied from interface: XAddingCollection
    
    Adds the passed element.
    
    Specified by:
    
    add in interface XAddingCollection<KeyValue<K,V>>
    
    Parameters:
    
    element - to add
    
    Returns:
    
    true if element was added; false if not
  - moveTo
```
public final <C extends Consumer<? super KeyValue<K,V>>> C moveTo(C target,
                                                                  Predicate<? super KeyValue<K,V>> predicate)
```
    Specified by:
    
    moveTo in interface XProcessingCollection<KeyValue<K,V>>
  - nullAdd
```
public final boolean nullAdd()
```
    Specified by:
    
    nullAdd in interface XAddingCollection<KeyValue<K,V>>
  - putGet
```
public final KeyValue<K,V> putGet(K key,
                                  V value)
```
    Description copied from interface: XMap
    
    Ensures the passed key and value to be contained as an entry in the map.
    
    Specified by:
    
    putGet in interface XMap<K,V>
    
    Specified by:
    
    putGet in interface XPutGetMap<K,V>
    
    Parameters:
    
    key - to add
    
    value - to add
    
    Returns:
    
    the old value or null
  - setGet
```
public final KeyValue<K,V> setGet(K key,
                                  V value)
```
    Description copied from interface: XMap
    
    Sets the passed key and value to an appropriate entry if one can be found.
    
    Specified by:
    
    setGet in interface XMap<K,V>
    
    Parameters:
    
    key - to find element to change
    
    value - to set
    
    Returns:
    
    the old value
  - spliterator
```
public final Spliterator<KeyValue<K,V>> spliterator()
```
    Specified by:
    
    spliterator in interface Iterable<KeyValue<K,V>>
  - valuePut
```
public final boolean valuePut(K sampleKey,
                              V value)
```
    Description copied from interface: XMap
    
    Ensures the passed value to be either set to an existing entry equal to sampleKey or inserted as a new one.
    
    Specified by:
    
    valuePut in interface XMap<K,V>
    
    Specified by:
    
    valuePut in interface XPuttingMap<K,V>
    
    Parameters:
    
    sampleKey - to find the an existing element
    
    value - to insert
    
    Returns:
    
    true if element was changed; false if not
  - size
```
public final long size()
```
    Specified by:
    
    size in interface Sized
    
    Specified by:
    
    size in interface XGettingCollection<KeyValue<K,V>>
  - isEmpty
```
public final boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Sized
  - equality
```
public final Equalator<? super KeyValue<K,V>> equality()
```
    Specified by:
    
    equality in interface XGettingCollection<KeyValue<K,V>>
  - equals
```
public final boolean equals(XGettingCollection<? extends KeyValue<K,V>> samples,
                            Equalator<? super KeyValue<K,V>> equalator)
```
    Specified by:
    
    equals in interface XGettingCollection<KeyValue<K,V>>
    
    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
  - valueSet
```
public final boolean valueSet(K sampleKey,
                              V value)
```
    Description copied from interface: XMap
    
    Sets only the passed value to an existing entry appropriate to the passed sampleKey.
    
    Specified by:
    
    valueSet in interface XAddingMap<K,V>
    
    Specified by:
    
    valueSet in interface XMap<K,V>
    
    Parameters:
    
    sampleKey - to find the an existing element
    
    value - to set
    
    Returns:
    
    true if element was changed; false if not
  - nullRemove
```
public final long nullRemove()
```
    Specified by:
    
    nullRemove in interface XRemovingCollection<KeyValue<K,V>>
  - removeOne
```
public final boolean removeOne(KeyValue<K,V> element)
```
    Specified by:
    
    removeOne in interface XRemovingCollection<KeyValue<K,V>>
  - valuePutGet
```
public final V valuePutGet(K sampleKey,
                           V value)
```
    Description copied from interface: XMap
    
    Ensures the passed value to be either set to an existing entry appropriate to sampleKey or inserted as a new one.
    
    Specified by:
    
    valuePutGet in interface XMap<K,V>
    
    Parameters:
    
    sampleKey - to find the an existing element
    
    value - to add
    
    Returns:
    
    the old value
  - equalsContent
```
public final boolean equalsContent(XGettingCollection<? extends KeyValue<K,V>> samples,
                                   Equalator<? super KeyValue<K,V>> 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<KeyValue<K,V>>
    
    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
  - remove
```
public final long remove(KeyValue<K,V> element)
```
    Specified by:
    
    remove in interface XRemovingCollection<KeyValue<K,V>>
  - removeAll
```
public final long removeAll(XGettingCollection<? extends KeyValue<K,V>> elements)
```
    Specified by:
    
    removeAll in interface XRemovingCollection<KeyValue<K,V>>
  - valueSetGet
```
public final V valueSetGet(K sampleKey,
                           V value)
```
    Description copied from interface: XMap
    
    Sets only the passed value to an existing entry appropriate to the passed sampleKey.
    
    Specified by:
    
    valueSetGet in interface XMap<K,V>
    
    Parameters:
    
    sampleKey - to find the an existing element
    
    value - to add
    
    Returns:
    
    the old value
  - retainAll
```
public final long retainAll(XGettingCollection<? extends KeyValue<K,V>> 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<KeyValue<K,V>>
    
    Parameters:
    
    elements - to retain
    
    Returns:
    
    Amount of deleted elements
  - removeDuplicates
```
public final long removeDuplicates()
```
    Specified by:
    
    removeDuplicates in interface XRemovingCollection<KeyValue<K,V>>
  - get
```
public final V get(K key)
```
    Specified by:
    
    get in interface XGettingMap<K,V>
    
    Specified by:
    
    get in interface XMap<K,V>
  - lookup
```
public final KeyValue<K,V> lookup(K key)
```
    Specified by:
    
    lookup in interface XGettingMap<K,V>
  - searchValue
```
public final V searchValue(Predicate<? super K> keyPredicate)
```
    Specified by:
    
    searchValue in interface XGettingMap<K,V>
    
    Specified by:
    
    searchValue in interface XMap<K,V>
  - immure
```
public final XImmutableMap<K,V> immure()
```
    Description copied from interface: XGettingMap
    
    Provides an instance of an immutable collection type with equal behavior and data as this instance.
    If this instance already is of an immutable collection type, it returns itself.
    
    Specified by:
    
    immure in interface XGettingCollection<KeyValue<K,V>>
    
    Specified by:
    
    immure in interface XGettingMap<K,V>
    
    Specified by:
    
    immure in interface XGettingSet<KeyValue<K,V>>
    
    Specified by:
    
    immure in interface XMap<K,V>
    
    Specified by:
    
    immure in interface XProcessingSet<KeyValue<K,V>>
    
    Returns:
    
    an immutable copy of this collection instance.
  - putAll
```
@SafeVarargs
public final XMap<K,V> putAll(KeyValue<K,V>... elements)
```
    Description copied from interface: XMap
    
    Ensures the passed key-value-pairs to be contained as entries in the map. A return value indicates a new entry.
    
    Specified by:
    
    putAll in interface XCollection<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XMap<K,V>
    
    Specified by:
    
    putAll in interface XPutGetCollection<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XPutGetSet<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XPuttingCollection<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XPuttingSet<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XSet<KeyValue<K,V>>
    
    Parameters:
    
    elements - to add
    
    Returns:
    
    this
  - putAll
```
public final XMap<K,V> putAll(KeyValue<K,V>[] elements,
                              int srcStartIndex,
                              int srcLength)
```
    Description copied from interface: XMap
    
    Ensures the passed key-value-pairs to be contained as entries in the map. Only the elements with indizes from the srcStartIndex to the srcStartIndex+srcLength are put in the collection.
    A return value indicates a new entry.
    
    Specified by:
    
    putAll in interface XCollection<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XMap<K,V>
    
    Specified by:
    
    putAll in interface XPutGetCollection<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XPutGetSet<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XPuttingCollection<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XPuttingSet<KeyValue<K,V>>
    
    Specified by:
    
    putAll in interface XSet<KeyValue<K,V>>
    
    Parameters:
    
    elements - to add
    
    srcStartIndex - start index of elements-array to add to collection
    
    srcLength - length of elements-array to add to collection
    
    Returns:
    
    this
  - addAll
```
@SafeVarargs
public final XMap<K,V> addAll(KeyValue<K,V>... elements)
```
    Specified by:
    
    addAll in interface XAddGetCollection<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XAddGetSet<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XAddingCollection<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XAddingSet<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XCollection<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XMap<K,V>
    
    Specified by:
    
    addAll in interface XPutGetCollection<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XPutGetSet<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XPuttingSet<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XSet<KeyValue<K,V>>
  - addAll
```
public final XMap<K,V> addAll(KeyValue<K,V>[] elements,
                              int srcStartIndex,
                              int srcLength)
```
    Specified by:
    
    addAll in interface XAddGetCollection<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XAddGetSet<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XAddingCollection<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XAddingSet<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XCollection<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XMap<K,V>
    
    Specified by:
    
    addAll in interface XPutGetCollection<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XPutGetSet<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XPuttingSet<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XSet<KeyValue<K,V>>
  - addAll
```
public final XMap<K,V> addAll(XGettingCollection<? extends KeyValue<K,V>> elements)
```
    Specified by:
    
    addAll in interface XAddGetCollection<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XAddGetSet<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XAddingCollection<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XAddingSet<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XCollection<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XMap<K,V>
    
    Specified by:
    
    addAll in interface XPutGetCollection<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XPutGetSet<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XPuttingSet<KeyValue<K,V>>
    
    Specified by:
    
    addAll in interface XSet<KeyValue<K,V>>
  - nullContained
```
public final boolean nullContained()
```
    Specified by:
    
    nullContained in interface XGettingCollection<KeyValue<K,V>>
  - containsId
```
public final boolean containsId(KeyValue<K,V> 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<KeyValue<K,V>>
    
    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(KeyValue<K,V> 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<KeyValue<K,V>>
    
    Parameters:
    
    element - to be searched in the collection
    
    Returns:
    
    Whether this collection contains the given element as specified by the Equalator.
  - containsSearched
```
public final boolean containsSearched(Predicate<? super KeyValue<K,V>> predicate)
```
    Specified by:
    
    containsSearched in interface XGettingCollection<KeyValue<K,V>>
  - containsAll
```
public final boolean containsAll(XGettingCollection<? extends KeyValue<K,V>> elements)
```
    Specified by:
    
    containsAll in interface XGettingCollection<KeyValue<K,V>>
    
    Parameters:
    
    elements - to be searched in the collection.
    
    Returns:
    
    Whether this collection contains all given elements as specified by the Equalator.
  - applies
```
public final boolean applies(Predicate<? super KeyValue<K,V>> predicate)
```
    Description copied from interface: XGettingCollection
    
    Tests each element of the collection on the given predicate.
    
    Specified by:
    
    applies in interface XGettingCollection<KeyValue<K,V>>
    
    Parameters:
    
    predicate - that's tested on each element.
    
    Returns:
    
    If all elements test successfully, true is returned. Otherwise (if at least one test has failed), false is returned.
  - count
```
public final long count(KeyValue<K,V> 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<KeyValue<K,V>>
    
    Parameters:
    
    element - to count
    
    Returns:
    
    Amount of matches
  - countBy
```
public final long countBy(Predicate<? super KeyValue<K,V>> 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<KeyValue<K,V>>
    
    Parameters:
    
    predicate - defines which elements are counted and which are not
    
    Returns:
    
    Amount of matches
  - search
```
public final KeyValue<K,V> search(Predicate<? super KeyValue<K,V>> predicate)
```
    Description copied from interface: XGettingCollection
    
    Returns the first contained element matching the passed predicate.
    
    Specified by:
    
    search in interface XGettingCollection<KeyValue<K,V>>
    
    Parameters:
    
    predicate - defines which element is searched
    
    Returns:
    
    Matching element
  - seek
```
public final KeyValue<K,V> seek(KeyValue<K,V> 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<KeyValue<K,V>>
    
    Parameters:
    
    sample - to seek in the collection
    
    Returns:
    
    the first contained element matching the passed sample
  - max
```
public final KeyValue<K,V> max(Comparator<? super KeyValue<K,V>> comparator)
```
    Specified by:
    
    max in interface XGettingCollection<KeyValue<K,V>>
  - min
```
public final KeyValue<K,V> min(Comparator<? super KeyValue<K,V>> comparator)
```
    Specified by:
    
    min in interface XGettingCollection<KeyValue<K,V>>
  - distinct
```
public final <T extends Consumer<? super KeyValue<K,V>>> T distinct(T 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<KeyValue<K,V>>
    
    Type Parameters:
    
    T - 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 <T extends Consumer<? super KeyValue<K,V>>> T distinct(T target,
                                                                    Equalator<? super KeyValue<K,V>> 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<KeyValue<K,V>>
    
    Type Parameters:
    
    T - 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
  - copyTo
```
public final <T extends Consumer<? super KeyValue<K,V>>> T copyTo(T 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<KeyValue<K,V>>
    
    Type Parameters:
    
    T - 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 <T extends Consumer<? super KeyValue<K,V>>> T filterTo(T target,
                                                                    Predicate<? super KeyValue<K,V>> 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<KeyValue<K,V>>
    
    Type Parameters:
    
    T - 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
  - union
```
public final <T extends Consumer<? super KeyValue<K,V>>> T union(XGettingCollection<? extends KeyValue<K,V>> other,
                                                                 Equalator<? super KeyValue<K,V>> equalator,
                                                                 T 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<KeyValue<K,V>>
    
    Type Parameters:
    
    T - 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
  - intersect
```
public final <T extends Consumer<? super KeyValue<K,V>>> T intersect(XGettingCollection<? extends KeyValue<K,V>> other,
                                                                     Equalator<? super KeyValue<K,V>> equalator,
                                                                     T 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<KeyValue<K,V>>
    
    Type Parameters:
    
    T - 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 <T extends Consumer<? super KeyValue<K,V>>> T except(XGettingCollection<? extends KeyValue<K,V>> other,
                                                                  Equalator<? super KeyValue<K,V>> equalator,
                                                                  T 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<KeyValue<K,V>>
    
    Type Parameters:
    
    T - type of the target
    
    Parameters:
    
    other - collection whose elements are excluded from the target.
    
    equalator - which is used for the equal-tests.
    
    target - on which the Consumer.accept(Object) is called for elements not contained in the other collection.
    
    Returns:
    
    Given target
  - equals
```
@Deprecated
public final boolean equals(Object o)
```
    Deprecated.
    
    Description copied from interface: XGettingCollection
    
    Performs an equality comparison according to the specification in Collection.
    Note that it is this interface's author opinion that the whole concept of equals() in standard Java, especially in the collection implementations, is flawed.
    The reason is because all different kinds of comparison types that actually depend on the situation have to be mixed up in a harcoded fashion in one method, from identity comparison over data indentity comparison to content comparison.
    In order to get the right behavior in every situation, one has to distinct between different types of equality
    
    This means several things:
    1.) You can't just say for example an ArrayList is the "same" as a LinkedList just because they contain the same content.
    There are different implementations for a good reason, so you have to distinct them when comparing. There are simple code examples which create massive misbehavior that will catastrophically ruin the runtime behavior of a programm due to this error in Java / JDK / Sun / whatever.
    2.) You can't always determine equality of two collections by determining equality of each element as Collection defines it.
    As a conclusion: don't use this method!
    Be clear what type of comparison you really need, then use one of the following methods and proper comparators:
    XGettingCollection.equals(XGettingCollection, Equalator)
    XGettingCollection.equalsContent(XGettingCollection, Equalator)
    
    Specified by:
    
    equals in interface XGettingCollection<KeyValue<K,V>>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - the reference object with which to compare.
  - hashCode
```
@Deprecated
public final int hashCode()
```
    Deprecated.
    
    Specified by:
    
    hashCode in interface XGettingCollection<KeyValue<K,V>>
    
    Overrides:
    
    hashCode in class Object

Class LockedMap<K,V>

Nested Class Summary

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

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

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

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

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

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

Method Detail

New

New

maximumCapacity

process

clear

join

nullAllowed

optimize

consolidate

truncate

removeFor

addGet

deduplicate

putGet

replace

addGet

substitute

replace

hasVolatileElements

keys

ensure

iterate

collector

putAll

values

ensureCapacity

remainingCapacity

old

oldMap

ensureFreeCapacity

copy

query

put

nullKeyAllowed

nullPut

isFull

nullValuesAllowed

currentCapacity

get

add

fetch

view

forEach

pinch

put

iterator

toArray

toArray

retrieve

retrieveBy

currentFreeCapacity

set

removeDuplicates

accept

removeBy

add

moveTo

nullAdd

putGet

setGet

spliterator

valuePut

size

isEmpty

equality

equals

valueSet

nullRemove