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.typing.Copyable
Copyable.Static

Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable
XIterable.Executor<E>

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>
Constructor Summary

Constructors

Constructor Description

LockedMap()

Method Summary

Modifier and Type	Method	Description
`void`	`accept(KeyValue<K,V> element)`
`boolean`	`add(K key, V value)`	Adds the passed key and value as an entry if key is not yet contained.
`boolean`	`add(KeyValue<K,V> element)`
`XMap<K,V>`	`addAll(XGettingCollection<? extends KeyValue<K,V>> elements)`
`XMap<K,V>`	`addAll(KeyValue<K,V>... elements)`
`XMap<K,V>`	`addAll(KeyValue<K,V>[] elements, int srcStartIndex, int srcLength)`
`KeyValue<K,V>`	`addGet(K key, V value)`
`KeyValue<K,V>`	`addGet(KeyValue<K,V> element)`
`boolean`	`applies(Predicate<? super KeyValue<K,V>> 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)`
`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)`
`long`	`count(KeyValue<K,V> element)`
`long`	`countBy(Predicate<? super KeyValue<K,V>> predicate)`
`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)`
`<T extends Consumer<? super KeyValue<K, V>>> T`	`distinct(T target, Equalator<? super KeyValue<K,V>> equalator)`
`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)`	Returns `true` if the passed collection is of the same type as this collection and`this.equalsContent(list, equalator)` yields `true`.
`boolean`	`equalsContent(XGettingCollection<? extends 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)`
`KeyValue<K,V>`	`fetch()`
`<T extends Consumer<? super KeyValue<K, V>>> T`	`filterTo(T target, Predicate<? super KeyValue<K,V>> 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)`
`boolean`	`isEmpty()`
`boolean`	`isFull()`	Returns true if the current capacity cannot be increased any more.
`<P extends Consumer<? super KeyValue<K, V>>> P`	`iterate(P procedure)`
`Iterator<KeyValue<K,V>>`	`iterator()`
`<A> A`	`join(BiConsumer<? super KeyValue<K,V>,? super A> joiner, A 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()`
`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(K key, V value)`	Ensures the passed key and value to be contained as an entry in the map.
`boolean`	`put(KeyValue<K,V> element)`
`XSet<KeyValue<K,V>>`	`putAll(XGettingCollection<? extends KeyValue<K,V>> elements)`
`XMap<K,V>`	`putAll(KeyValue<K,V>... elements)`
`XMap<K,V>`	`putAll(KeyValue<K,V>[] elements, int srcStartIndex, int srcLength)`
`KeyValue<K,V>`	`putGet(K key, V value)`	Ensures the passed key and value to be contained as an entry in the map.
`KeyValue<K,V>`	`putGet(KeyValue<K,V> element)`
`<C extends Consumer<? super V>> C`	`query(XIterable<? extends K> keys, C collector)`
`long`	`remainingCapacity()`	Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.
`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(K key, V value)`
`KeyValue<K,V>`	`replace(KeyValue<K,V> element)`
`long`	`retainAll(XGettingCollection<? extends KeyValue<K,V>> elements)`
`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)`
`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()`
`KeyValue<K,V>[]`	`toArray(Class<KeyValue<K,V>> type)`
`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)`
`boolean`	`valuePut(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.
`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()`

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Consumer

andThen

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

intSize

Constructor Details
- LockedMap
  
  public LockedMap()
Method Details
- 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<K>
- 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 Clearable
  
  Specified by:
  
  clear in interface XRemovingCollection<K>
- join
  
  public final <A> A join(BiConsumer<? super KeyValue<K,V>,? super A> joiner, A aggregate)
  
  Specified by:
  
  join in interface XGettingCollection<K>
  
  Specified by:
  
  join in interface XJoinable<K>
- nullAllowed
  
  public final boolean nullAllowed()
  
  Specified by:
  
  nullAllowed in interface ExtendedCollection<K>
- 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<K>
  
  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).
  If this is not possible or not needed in the concrete implementation, this method does nothing and returns 0.
  
  Specified by:
  
  consolidate in interface ConsolidatableCollection
  
  Specified by:
  
  consolidate in interface XRemovingCollection<K>
  
  Returns:
  
  the number of discarded entries.
- 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<K>
- 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<K>
- deduplicate
  
  public final KeyValue<K,V> deduplicate(KeyValue<K,V> element)
  
  Specified by:
  
  deduplicate in interface XAddGetSet<K>
- putGet
  
  public final KeyValue<K,V> putGet(KeyValue<K,V> element)
  
  Specified by:
  
  putGet in interface XPutGetSet<K>
- replace
  
  public final KeyValue<K,V> replace(KeyValue<K,V> element)
  
  Specified by:
  
  replace in interface XPutGetSet<K>
- 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: XGettingCollection
  
  Tells if this collection contains volatile elements.
  An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. Examples are WeakReference of SoftReference or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
  Note that WeakReference instances that are added to a a simple (non-volatile) implementation of a collection do NOT make the collection volatile, as the elements themselves (the reference instances) are still strongly referenced.
  
  Specified by:
  
  hasVolatileElements in interface ExtendedCollection<K>
  
  Specified by:
  
  hasVolatileElements in interface XGettingCollection<K>
  
  Returns:
  
  true if the collection contains volatile elements.
- 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)
  
  Specified by:
  
  iterate in interface XGettingSet<K>
  
  Specified by:
  
  iterate in interface XIterable<K>
  
  Specified by:
  
  iterate in interface XProcessingCollection<K>
- collector
  
  public final Aggregator<KeyValue<K,V>,? extends XCollection<KeyValue<K,V>>> collector()
  
  Specified by:
  
  collector in interface XAddingCollection<K>
  
  Specified by:
  
  collector in interface XCollection<K>
- putAll
  
  public final XSet<KeyValue<K,V>> putAll(XGettingCollection<? extends KeyValue<K,V>> elements)
  
  Specified by:
  
  putAll in interface XCollection<K>
  
  Specified by:
  
  putAll in interface XPutGetCollection<K>
  
  Specified by:
  
  putAll in interface XPutGetSet<K>
  
  Specified by:
  
  putAll in interface XPuttingCollection<K>
  
  Specified by:
  
  putAll in interface XPuttingSet<K>
  
  Specified by:
  
  putAll in interface XSet<K>
- 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()
  
  Description copied from interface: CapacityCarrying
  
  Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.
  
  Specified by:
  
  remainingCapacity in interface CapacityCarrying
- old
  
  public final XMap.EntriesBridge<K,V> old()
  
  Specified by:
  
  old in interface XGettingCollection<K>
  
  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
- 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 Copyable
  
  Specified by:
  
  copy in interface XAddGetCollection<K>
  
  Specified by:
  
  copy in interface XAddGetSet<K>
  
  Specified by:
  
  copy in interface XCollection<K>
  
  Specified by:
  
  copy in interface XGettingCollection<K>
  
  Specified by:
  
  copy in interface XGettingMap<K,V>
  
  Specified by:
  
  copy in interface XGettingSet<K>
  
  Specified by:
  
  copy in interface XMap<K,V>
  
  Specified by:
  
  copy in interface XProcessingMap<K,V>
  
  Specified by:
  
  copy in interface XProcessingSet<K>
  
  Specified by:
  
  copy in interface XPutGetCollection<K>
  
  Specified by:
  
  copy in interface XPutGetSet<K>
  
  Specified by:
  
  copy in interface XSet<K>
  
  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)
  
  Specified by:
  
  put in interface XPuttingCollection<K>
- 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<K>
- isFull
  
  public final boolean isFull()
  
  Description copied from interface: CapacityCarrying
  
  Returns true if the current capacity cannot be increased any more.
  
  Specified by:
  
  isFull in interface CapacityCarrying
- 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<K>
  
  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>
- fetch
  
  public final KeyValue<K,V> fetch()
  
  Specified by:
  
  fetch in interface XProcessingCollection<K>
- view
  
  public final XGettingMap<K,V> view()
  
  Specified by:
  
  view in interface XGettingCollection<K>
  
  Specified by:
  
  view in interface XGettingMap<K,V>
- forEach
  
  public final void forEach(Consumer<? super KeyValue<K,V>> action)
  
  Specified by:
  
  forEach in interface Iterable<K>
- pinch
  
  public final KeyValue<K,V> pinch()
  
  Specified by:
  
  pinch in interface XProcessingCollection<K>
- 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. Return value indicates new entry.
  
  Specified by:
  
  put in interface XMap<K,V>
  
  Specified by:
  
  put in interface XPuttingMap<K,V>
- iterator
  
  public final Iterator<KeyValue<K,V>> iterator()
  
  Specified by:
  
  iterator in interface Iterable<K>
  
  Specified by:
  
  iterator in interface XGettingCollection<K>
- toArray
  
  public final Object[] toArray()
  
  Specified by:
  
  toArray in interface XGettingCollection<K>
- toArray
  
  public final KeyValue<K,V>[] toArray(Class<KeyValue<K,V>> type)
  
  Specified by:
  
  toArray in interface XGettingCollection<K>
- retrieve
  
  public final KeyValue<K,V> retrieve(KeyValue<K,V> element)
  
  Specified by:
  
  retrieve in interface XProcessingCollection<K>
- retrieveBy
  
  public final KeyValue<K,V> retrieveBy(Predicate<? super KeyValue<K,V>> predicate)
  
  Specified by:
  
  retrieveBy in interface XProcessingCollection<K>
- 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. Return value indicates entry change.
  
  Specified by:
  
  set in interface XAddingMap<K,V>
  
  Specified by:
  
  set in interface XMap<K,V>
- removeDuplicates
  
  public final long removeDuplicates(Equalator<? super KeyValue<K,V>> equalator)
  
  Specified by:
  
  removeDuplicates in interface XProcessingCollection<K>
- accept
  
  public final void accept(KeyValue<K,V> element)
  
  Specified by:
  
  accept in interface Consumer<K>
  
  Specified by:
  
  accept in interface XAddingCollection<K>
- removeBy
  
  public final long removeBy(Predicate<? super KeyValue<K,V>> predicate)
  
  Specified by:
  
  removeBy in interface XProcessingCollection<K>
- add
  
  public final boolean add(KeyValue<K,V> element)
  
  Specified by:
  
  add in interface XAddingCollection<K>
- 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<K>
- nullAdd
  
  public final boolean nullAdd()
  
  Specified by:
  
  nullAdd in interface XAddingCollection<K>
- 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. Returns the old value or null.
  
  Specified by:
  
  putGet in interface XMap<K,V>
  
  Specified by:
  
  putGet in interface XPutGetMap<K,V>
- 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. Returns the old value.
  
  Specified by:
  
  setGet in interface XMap<K,V>
- spliterator
  
  public final Spliterator<KeyValue<K,V>> spliterator()
  
  Specified by:
  
  spliterator in interface Iterable<K>
- 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 appropriate to sampleKey or inserted as a new one.
  
  Specified by:
  
  valuePut in interface XMap<K,V>
  
  Specified by:
  
  valuePut in interface XPuttingMap<K,V>
- size
  
  public final long size()
  
  Specified by:
  
  size in interface Sized
  
  Specified by:
  
  size in interface XGettingCollection<K>
- 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<K>
- equals
  
  public final boolean equals(XGettingCollection<? extends KeyValue<K,V>> samples, Equalator<? super KeyValue<K,V>> equalator)
  
  Description copied from interface: XGettingCollection
  
  Returns true if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator) yields true.
  
  Specified by:
  
  equals in interface XGettingCollection<K>
- 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. Returns value indicates change.
  
  Specified by:
  
  valueSet in interface XAddingMap<K,V>
  
  Specified by:
  
  valueSet in interface XMap<K,V>
- nullRemove
  
  public final long nullRemove()
  
  Specified by:
  
  nullRemove in interface XRemovingCollection<K>
- removeOne
  
  public final boolean removeOne(KeyValue<K,V> element)
  
  Specified by:
  
  removeOne in interface XRemovingCollection<K>
- 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>
- 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<K>
  
  equalator - the equalator to use to determine the equality of each element
  
  Returns:
  
  true if this list is equal to the passed list, false otherwise
- remove
  
  public final long remove(KeyValue<K,V> element)
  
  Specified by:
  
  remove in interface XRemovingCollection<K>
- removeAll
  
  public final long removeAll(XGettingCollection<? extends KeyValue<K,V>> elements)
  
  Specified by:
  
  removeAll in interface XRemovingCollection<K>
- 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. Returns the old value.
  
  Specified by:
  
  valueSetGet in interface XMap<K,V>
- retainAll
  
  public final long retainAll(XGettingCollection<? extends KeyValue<K,V>> elements)
  
  Specified by:
  
  retainAll in interface XRemovingCollection<K>
- removeDuplicates
  
  public final long removeDuplicates()
  
  Specified by:
  
  removeDuplicates in interface XRemovingCollection<K>
- 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<K>
  
  Specified by:
  
  immure in interface XGettingMap<K,V>
  
  Specified by:
  
  immure in interface XGettingSet<K>
  
  Specified by:
  
  immure in interface XMap<K,V>
  
  Specified by:
  
  immure in interface XProcessingSet<K>
  
  Returns:
  
  an immutable copy of this collection instance.
- putAll
  
  @SafeVarargs public final XMap<K,V> putAll(KeyValue<K,V>... elements)
  
  Specified by:
  
  putAll in interface XCollection<K>
  
  Specified by:
  
  putAll in interface XMap<K,V>
  
  Specified by:
  
  putAll in interface XPutGetCollection<K>
  
  Specified by:
  
  putAll in interface XPutGetSet<K>
  
  Specified by:
  
  putAll in interface XPuttingCollection<K>
  
  Specified by:
  
  putAll in interface XPuttingSet<K>
  
  Specified by:
  
  putAll in interface XSet<K>
- putAll
  
  public final XMap<K,V> putAll(KeyValue<K,V>[] elements, int srcStartIndex, int srcLength)
  
  Specified by:
  
  putAll in interface XCollection<K>
  
  Specified by:
  
  putAll in interface XMap<K,V>
  
  Specified by:
  
  putAll in interface XPutGetCollection<K>
  
  Specified by:
  
  putAll in interface XPutGetSet<K>
  
  Specified by:
  
  putAll in interface XPuttingCollection<K>
  
  Specified by:
  
  putAll in interface XPuttingSet<K>
  
  Specified by:
  
  putAll in interface XSet<K>
- addAll
  
  @SafeVarargs public final XMap<K,V> addAll(KeyValue<K,V>... 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 XAddingSet<K>
  
  Specified by:
  
  addAll in interface XCollection<K>
  
  Specified by:
  
  addAll in interface XMap<K,V>
  
  Specified by:
  
  addAll in interface XPutGetCollection<K>
  
  Specified by:
  
  addAll in interface XPutGetSet<K>
  
  Specified by:
  
  addAll in interface XPuttingSet<K>
  
  Specified by:
  
  addAll in interface XSet<K>
- addAll
  
  public final XMap<K,V> addAll(KeyValue<K,V>[] elements, int srcStartIndex, 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 XAddingSet<K>
  
  Specified by:
  
  addAll in interface XCollection<K>
  
  Specified by:
  
  addAll in interface XMap<K,V>
  
  Specified by:
  
  addAll in interface XPutGetCollection<K>
  
  Specified by:
  
  addAll in interface XPutGetSet<K>
  
  Specified by:
  
  addAll in interface XPuttingSet<K>
  
  Specified by:
  
  addAll in interface XSet<K>
- addAll
  
  public final XMap<K,V> addAll(XGettingCollection<? extends KeyValue<K,V>> 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 XAddingSet<K>
  
  Specified by:
  
  addAll in interface XCollection<K>
  
  Specified by:
  
  addAll in interface XMap<K,V>
  
  Specified by:
  
  addAll in interface XPutGetCollection<K>
  
  Specified by:
  
  addAll in interface XPutGetSet<K>
  
  Specified by:
  
  addAll in interface XPuttingSet<K>
  
  Specified by:
  
  addAll in interface XSet<K>
- nullContained
  
  public final boolean nullContained()
  
  Specified by:
  
  nullContained in interface XGettingCollection<K>
- 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<K>
  
  Parameters:
  
  element - the element to be searched in the collection by identity.
  
  Returns:
  
  whether this collection contains exactely the given element.
- contains
  
  public final boolean contains(KeyValue<K,V> element)
  
  Specified by:
  
  contains in interface XGettingCollection<K>
- containsSearched
  
  public final boolean containsSearched(Predicate<? super KeyValue<K,V>> predicate)
  
  Specified by:
  
  containsSearched in interface XGettingCollection<K>
- containsAll
  
  public final boolean containsAll(XGettingCollection<? extends KeyValue<K,V>> elements)
  
  Specified by:
  
  containsAll in interface XGettingCollection<K>
- applies
  
  public final boolean applies(Predicate<? super KeyValue<K,V>> predicate)
  
  Specified by:
  
  applies in interface XGettingCollection<K>
- count
  
  public final long count(KeyValue<K,V> element)
  
  Specified by:
  
  count in interface XGettingCollection<K>
- countBy
  
  public final long countBy(Predicate<? super KeyValue<K,V>> predicate)
  
  Specified by:
  
  countBy in interface XGettingCollection<K>
- search
  
  public final KeyValue<K,V> search(Predicate<? super KeyValue<K,V>> predicate)
  
  Specified by:
  
  search in interface XGettingCollection<K>
- 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<K>
- max
  
  public final KeyValue<K,V> max(Comparator<? super KeyValue<K,V>> comparator)
  
  Specified by:
  
  max in interface XGettingCollection<K>
- min
  
  public final KeyValue<K,V> min(Comparator<? super KeyValue<K,V>> comparator)
  
  Specified by:
  
  min in interface XGettingCollection<K>
- distinct
  
  public final <T extends Consumer<? super KeyValue<K, V>>> T distinct(T target)
  
  Specified by:
  
  distinct in interface XGettingCollection<K>
- distinct
  
  public final <T extends Consumer<? super KeyValue<K, V>>> T distinct(T target, Equalator<? super KeyValue<K,V>> equalator)
  
  Specified by:
  
  distinct in interface XGettingCollection<K>
- copyTo
  
  public final <T extends Consumer<? super KeyValue<K, V>>> T copyTo(T target)
  
  Specified by:
  
  copyTo in interface XGettingCollection<K>
- filterTo
  
  public final <T extends Consumer<? super KeyValue<K, V>>> T filterTo(T target, Predicate<? super KeyValue<K,V>> predicate)
  
  Specified by:
  
  filterTo in interface XGettingCollection<K>
- 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)
  
  Specified by:
  
  union in interface XGettingCollection<K>
- 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)
  
  Specified by:
  
  intersect in interface XGettingCollection<K>
- 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)
  
  Specified by:
  
  except in interface XGettingCollection<K>
- 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<K>
  
  Overrides:
  
  equals in class Object
- hashCode
  
  @Deprecated public final int hashCode()
  
  Deprecated.
  
  Specified by:
  
  hashCode in interface XGettingCollection<K>
  
  Overrides:
  
  hashCode in class Object

Class LockedMap<K,​V>

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.function.Consumer

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

Constructor Details

Method Details

Class LockedMap<K,V>