net.openhft.chronicle.engine.api.map

Interface KeyValueStore<K,MV,V>

Type Parameters:

K - key type

MV - mutable value type

V - immutable value type

All Superinterfaces:

Assetted<KeyValueStore<K,MV,V>>, AutoCloseable, Closeable, java.util.function.Consumer<EngineReplication.ReplicationEntry>, View

All Known Subinterfaces:

AuthenticatedKeyValueStore<K,MV,V>, ObjectKeyValueStore<K,MV,V>, StringBytesStoreKeyValueStore, StringMarshallableKeyValueStore<V>, StringStringKeyValueStore, SubscriptionKeyValueStore<K,MV,V>

All Known Implementing Classes:

AbstractKeyValueStore, AbstractSubscriptionKeyValueStore, ChronicleMapKeyValueStore, FilePerKeyValueStore, ObjectObjectKeyValueStore, RemoteKeyValueStore, VanillaKeyValueStore, VanillaStringMarshallableKeyValueStore, VanillaStringStringKeyValueStore, VanillaSubscriptionKeyValueStore

public interface KeyValueStore<K,MV,V>
extends Assetted<KeyValueStore<K,MV,V>>, View, net.openhft.chronicle.core.io.Closeable, java.util.function.Consumer<EngineReplication.ReplicationEntry>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	KeyValueStore.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
void	clear()
default boolean	containsKey(K key)
boolean	containsValue(MV value)
void	entriesFor(int segment, SubscriptionConsumer<MapEvent<K,V>> kvConsumer)
default Iterator<Map.Entry<K,V>>	entrySetIterator()
default V	get(K key)
V	getAndPut(K key, V value)
V	getAndRemove(K key)
V	getUsing(K key, MV value)
default boolean	isKeyType(Object key)
default boolean	isReadOnly()
default boolean	keyedView()
default Iterator<K>	keySetIterator()
void	keysFor(int segment, SubscriptionConsumer<K> kConsumer)
long	longSize()
default boolean	put(K key, V value) put an entry
default V	putIfAbsent(K key, V value)
default boolean	remove(K key) remove a key
default boolean	removeIfEqual(K key, V value)
default V	replace(K key, V value)
default boolean	replaceIfEqual(K key, V oldValue, V newValue)
default int	segmentFor(K key)
default int	segments()
default Iterator<V>	valuesIterator()

Methods inherited from interface net.openhft.chronicle.engine.api.tree.Assetted

asset, underlying

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

close, closeQuietly

Methods inherited from interface java.util.function.Consumer

accept, andThen

Method Detail

put

default boolean put(K key,
                    V value)

put an entry

Parameters:

key - to set

value - to set

Returns:

true if it was replaced, false if it was added.

getAndPut

V getAndPut(K key,
            V value)

remove

default boolean remove(K key)

remove a key

Parameters:

key - to remove

Returns:

true if it was removed, false if not.

getAndRemove

V getAndRemove(K key)

get

@Nullable
default V get(K key)

getUsing

@Nullable
V getUsing(K key,
                     MV value)

containsKey

default boolean containsKey(K key)

isReadOnly

default boolean isReadOnly()

longSize

long longSize()

segments

default int segments()

segmentFor

default int segmentFor(K key)

keysFor

void keysFor(int segment,
             SubscriptionConsumer<K> kConsumer)
      throws InvalidSubscriberException

Throws:

InvalidSubscriberException

entriesFor

void entriesFor(int segment,
                SubscriptionConsumer<MapEvent<K,V>> kvConsumer)
         throws InvalidSubscriberException

Throws:

InvalidSubscriberException

entrySetIterator

default Iterator<Map.Entry<K,V>> entrySetIterator()

keySetIterator

default Iterator<K> keySetIterator()

clear

void clear()

replace

@Nullable
default V replace(K key,
                            V value)

replaceIfEqual

default boolean replaceIfEqual(K key,
                               V oldValue,
                               V newValue)

removeIfEqual

default boolean removeIfEqual(K key,
                              V value)

isKeyType

default boolean isKeyType(Object key)

putIfAbsent

default V putIfAbsent(K key,
                      V value)

keyedView

default boolean keyedView()

Specified by:

keyedView in interface View

valuesIterator

default Iterator<V> valuesIterator()

containsValue

boolean containsValue(MV value)