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

All Implemented Interfaces:

Iterable<KeyValue<K,V>>, CapacityCarrying, ExtendedCollection<KeyValue<K,V>>, ExtendedMap<K,V>, Sized, XGettingCollection<KeyValue<K,V>>, XGettingMap<K,V>, XGettingSet<KeyValue<K,V>>, XIterable<KeyValue<K,V>>, XJoinable<KeyValue<K,V>>, Synchronized, ThreadSafe, Copyable
```
public final class LockedGettingMap<K,V>
extends Object
implements XGettingMap<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.XGettingMap
  XGettingMap.Bridge<K,V>, XGettingMap.Creator<K,V>, XGettingMap.EntriesBridge<K,V>, XGettingMap.Keys<K,V>, XGettingMap.Satellite<K,V>, XGettingMap.Values<K,V>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable
  XIterable.Executor<E>

Constructor Summary

Constructors
Constructor Description

LockedGettingMap()

Method Summary

Modifier and Type	Method	Description
`boolean`	`applies(Predicate<? super KeyValue<K,V>> predicate)`
`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)`
`XGettingMap<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)`
`<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)`
`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)`
`<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)`
`XGettingMap.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)`
`static <K,V> LockedGettingMap<K,V>`	`New(XGettingMap<K,V> subject)`
`static <K,V> LockedGettingMap<K,V>`	`New(XGettingMap<K,V> subject, Object lock)`
`boolean`	`nullAllowed()`
`boolean`	`nullContained()`
`boolean`	`nullKeyAllowed()`
`boolean`	`nullValuesAllowed()`
`XGettingMap.EntriesBridge<K,V>`	`old()`
`XGettingMap.Bridge<K,V>`	`oldMap()`
`<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.
`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.
`long`	`size()`
`Spliterator<KeyValue<K,V>>`	`spliterator()`
`Object[]`	`toArray()`
`KeyValue<K,V>[]`	`toArray(Class<KeyValue<K,V>> type)`
`<T extends Consumer<? super KeyValue<K,V>>> T`	`union(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> equalator, T target)`
`XGettingMap.Values<K,V>`	`values()`
`XGettingMap<K,V>`	`view()`

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

- Constructor Detail
  - LockedGettingMap
```
public LockedGettingMap()
```
- Method Detail
  - New
```
public static <K,V> LockedGettingMap<K,V> New(XGettingMap<K,V> subject)
```
  - New
```
public static <K,V> LockedGettingMap<K,V> New(XGettingMap<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.
  - 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>
  - 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 XGettingMap.Keys<K,V> keys()
```
    Specified by:
    
    keys in interface XGettingMap<K,V>
  - 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>
  - values
```
public final XGettingMap.Values<K,V> values()
```
    Specified by:
    
    values in interface XGettingMap<K,V>
  - 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 XGettingMap.EntriesBridge<K,V> old()
```
    Specified by:
    
    old in interface XGettingCollection<K>
    
    Specified by:
    
    old in interface XGettingMap<K,V>
  - oldMap
```
public final XGettingMap.Bridge<K,V> oldMap()
```
    Specified by:
    
    oldMap in interface XGettingMap<K,V>
  - copy
```
public final XGettingMap<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 XGettingCollection<K>
    
    Specified by:
    
    copy in interface XGettingMap<K,V>
    
    Specified by:
    
    copy in interface XGettingSet<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>
  - nullKeyAllowed
```
public final boolean nullKeyAllowed()
```
    Specified by:
    
    nullKeyAllowed in interface XGettingMap<K,V>
  - 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 XGettingMap<K,V>
  - 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.
  - lookup
```
public final KeyValue<K,V> lookup(K key)
```
    Specified by:
    
    lookup in interface XGettingMap<K,V>
  - 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>
  - 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>
  - spliterator
```
public final Spliterator<KeyValue<K,V>> spliterator()
```
    Specified by:
    
    spliterator in interface Iterable<K>
  - 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>
  - 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
  - get
```
public final V get(K key)
```
    Specified by:
    
    get in interface XGettingMap<K,V>
  - searchValue
```
public final V searchValue(Predicate<? super K> keyPredicate)
```
    Specified by:
    
    searchValue in interface XGettingMap<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>
    
    Returns:
    
    an immutable copy of this collection instance.
  - 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 LockedGettingMap<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.XGettingMap

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

LockedGettingMap

Method Detail

New

New

maximumCapacity

join

nullAllowed

hasVolatileElements

keys

iterate

values

remainingCapacity

old

oldMap

copy

query

nullKeyAllowed

isFull

nullValuesAllowed

get

lookup

view

forEach

iterator

toArray

toArray

spliterator

size

isEmpty

equality

equals

equalsContent

get

searchValue

immure

nullContained

containsId

contains

containsSearched

containsAll

applies

count

countBy

search

seek

max

min

distinct

distinct

copyTo

filterTo

union

intersect

except

equals

hashCode

Class LockedGettingMap<K,V>