one.microstream.collections.types

Interface XMap<K,V>

Type Parameters:

K - type of contained keys

V - type of contained values

All Superinterfaces:

CapacityCarrying, CapacityExtendable, Clearable, ConsolidatableCollection, Consumer<KeyValue<K,V>>, Copyable, ExtendedCollection<KeyValue<K,V>>, ExtendedMap<K,V>, Iterable<KeyValue<K,V>>, OptimizableCollection, Processable<KeyValue<K,V>>, 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>>, 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>>

All Known Subinterfaces:

XBasicTable<K,V>, XChart<K,V>, XTable<K,V>

All Known Implementing Classes:

EqHashTable, HashTable, LockedMap

public interface XMap<K,V>
extends XProcessingMap<K,V>, XPutGetMap<K,V>, XSet<KeyValue<K,V>>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	XMap.Bridge<K,V>
static interface	XMap.Creator<K,V>
static interface	XMap.EntriesBridge<K,V>
static interface	XMap.Keys<K,V>
static interface	XMap.Satellite<K,V>
static interface	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

Modifier and Type	Method and Description
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)
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.
V	get(K key)
XImmutableMap<K,V>	immure() Provides an instance of an immutable collection type with equal behavior and data as this instance.
XMap.Keys<K,V>	keys()
boolean	nullKeyAllowed()
boolean	nullValuesAllowed()
XMap.EntriesBridge<K,V>	old()
XMap.Bridge<K,V>	oldMap()
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.
KeyValue<K,V>	putGet(K key, V value) Ensures the passed key and value to be contained as an entry in the map.
V	searchValue(Predicate<? super K> keyPredicate)
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.
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.

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

removeFor

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

replace

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

addGet, ensure, substitute

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

lookup, query, view

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

putAll

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

collector

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

putGet, replace

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

addGet, deduplicate

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

applies, contains, containsAll, containsId, containsSearched, copyTo, count, countBy, distinct, distinct, equality, equals, equals, equalsContent, except, filterTo, get, hashCode, hasVolatileElements, intersect, intSize, iterator, join, max, min, nullContained, search, seek, size, toArray, toArray, union

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

nullPut, put

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

accept, add, nullAdd

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

nullAllowed

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

currentCapacity, currentFreeCapacity, ensureCapacity, ensureFreeCapacity

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

isFull, maximumCapacity, remainingCapacity

Methods inherited from interface java.util.function.Consumer

andThen

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

fetch, iterate, moveTo, pinch, removeBy, removeDuplicates, retrieve, retrieveBy

Methods inherited from interface one.microstream.functional.Processable

process

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

clear, consolidate, nullRemove, optimize, remove, removeAll, removeDuplicates, removeOne, retainAll, truncate

Method Detail

keys

XMap.Keys<K,V> keys()

Specified by:

keys in interface XGettingMap<K,V>

Specified by:

keys in interface XProcessingMap<K,V>

values

XMap.Values<K,V> values()

Specified by:

values in interface XGettingMap<K,V>

Specified by:

values in interface XProcessingMap<K,V>

old

XMap.EntriesBridge<K,V> old()

Specified by:

old in interface XGettingCollection<KeyValue<K,V>>

Specified by:

old in interface XGettingMap<K,V>

oldMap

XMap.Bridge<K,V> oldMap()

Specified by:

oldMap in interface XGettingMap<K,V>

copy

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

Returns:

a copy of this list

nullKeyAllowed

boolean nullKeyAllowed()

Specified by:

nullKeyAllowed in interface XAddingMap<K,V>

Specified by:

nullKeyAllowed in interface XGettingMap<K,V>

nullValuesAllowed

boolean nullValuesAllowed()

Specified by:

nullValuesAllowed in interface XAddingMap<K,V>

Specified by:

nullValuesAllowed in interface XGettingMap<K,V>

add

boolean add(K key,
            V value)

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>

Parameters:

key - to add

value - to add

Returns:

true if element was added; false if not

put

boolean put(K key,
            V value)

Ensures the passed key and value to be contained as an entry in the map.

Specified by:

put in interface XPuttingMap<K,V>

Parameters:

key - to add

value - to add

Returns:

true if element was added; false if not

set

boolean set(K key,
            V value)

Sets the passed key and value to an appropriate entry if one can be found.

Specified by:

set in interface XAddingMap<K,V>

Parameters:

key - to find element to change

value - to set

Returns:

true if element was changed; false if not

putGet

KeyValue<K,V> putGet(K key,
                     V value)

Ensures the passed key and value to be contained as an entry in the map.

Specified by:

putGet in interface XPutGetMap<K,V>

Parameters:

key - to add

value - to add

Returns:

the old value or null

setGet

KeyValue<K,V> setGet(K key,
                     V value)

Sets the passed key and value to an appropriate entry if one can be found.

Parameters:

key - to find element to change

value - to set

Returns:

the old value

valuePut

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.

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

valueSet

boolean valueSet(K sampleKey,
                 V value)

Sets only the passed value to an existing entry appropriate to the passed sampleKey.

Specified by:

valueSet in interface XAddingMap<K,V>

Parameters:

sampleKey - to find the an existing element

value - to set

Returns:

true if element was changed; false if not

valuePutGet

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.

Parameters:

sampleKey - to find the an existing element

value - to add

Returns:

the old value

valueSetGet

V valueSetGet(K sampleKey,
              V value)

Sets only the passed value to an existing entry appropriate to the passed sampleKey.

Parameters:

sampleKey - to find the an existing element

value - to add

Returns:

the old value

get

V get(K key)

Specified by:

get in interface XGettingMap<K,V>

searchValue

V searchValue(Predicate<? super K> keyPredicate)

Specified by:

searchValue in interface XGettingMap<K,V>

immure

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 XProcessingSet<KeyValue<K,V>>

Returns:

an immutable copy of this collection instance.

putAll

XMap<K,V> putAll(KeyValue<K,V>... elements)

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

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

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

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

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