net.openhft.chronicle.engine.map

Class AbstractKeyValueStore<K,MV,V>

java.lang.Object

net.openhft.chronicle.engine.map.AbstractKeyValueStore<K,MV,V>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSubscriptionKeyValueStore, VanillaSubscriptionKeyValueStore

public class AbstractKeyValueStore<K,MV,V>
extends Object
implements KeyValueStore<K,MV,V>

Created by peter on 22/05/15.

Nested Class Summary

Nested classes/interfaces inherited from interface net.openhft.chronicle.engine.api.map.KeyValueStore

KeyValueStore.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected Asset	asset
protected Class<K>	keyType
protected KeyValueStore<K,MV,V>	kvStore
protected Class<V>	valueType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractKeyValueStore(RequestContext rc, Asset asset, KeyValueStore<K,MV,V> kvStore)

Method Summary

Modifier and Type	Method and Description
void	accept(EngineReplication.ReplicationEntry replicationEntry)
Asset	asset()
void	clear()
void	close()
boolean	containsKey(K key)
boolean	containsValue(V value)
void	entriesFor(int segment, SubscriptionConsumer<MapEvent<K,V>> kvConsumer)
Iterator<Map.Entry<K,V>>	entrySetIterator()
V	get(K key)
V	getAndPut(K key, V value)
V	getAndRemove(K key)
V	getUsing(K key, MV value)
boolean	isKeyType(Object key)
boolean	isReadOnly()
boolean	keyedView() If you attach a keyed view to an Asset, it is assumed that any child asset with be a SubAsset.
Iterator<K>	keySetIterator()
void	keysFor(int segment, SubscriptionConsumer<K> kConsumer)
Class<K>	keyType()
long	longSize()
boolean	put(K key, V value) put an entry
V	putIfAbsent(K key, V value)
boolean	remove(K key) remove a key
boolean	removeIfEqual(K key, V value)
V	replace(K key, V value)
boolean	replaceIfEqual(K key, V oldValue, V newValue)
int	segmentFor(K key)
int	segments()
KeyValueStore	underlying()
Class<V>	valueType()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.engine.api.map.KeyValueStore

valuesIterator

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

closeQuietly

Methods inherited from interface java.util.function.Consumer

andThen

Field Detail

asset

@NotNull
protected final Asset asset

kvStore

@NotNull
protected final KeyValueStore<K,MV,V> kvStore

keyType

protected final Class<K> keyType

valueType

protected final Class<V> valueType

Constructor Detail

AbstractKeyValueStore

protected AbstractKeyValueStore(@NotNull
                                RequestContext rc,
                                @NotNull
                                Asset asset,
                                @NotNull
                                KeyValueStore<K,MV,V> kvStore)

Method Detail

underlying

@NotNull
public KeyValueStore underlying()

Specified by:

underlying in interface Assetted<KeyValueStore<K,MV,V>>

Returns:

The Underlying view this view is built on.

getAndPut

@Nullable
public V getAndPut(K key,
                             V value)

Specified by:

getAndPut in interface KeyValueStore<K,MV,V>

getAndRemove

@Nullable
public V getAndRemove(K key)

Specified by:

getAndRemove in interface KeyValueStore<K,MV,V>

getUsing

@Nullable
public V getUsing(K key,
                            MV value)

Specified by:

getUsing in interface KeyValueStore<K,MV,V>

entrySetIterator

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

Specified by:

entrySetIterator in interface KeyValueStore<K,MV,V>

longSize

public long longSize()

Specified by:

longSize in interface KeyValueStore<K,MV,V>

keysFor

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

Specified by:

keysFor in interface KeyValueStore<K,MV,V>

Throws:

InvalidSubscriberException

entriesFor

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

Specified by:

entriesFor in interface KeyValueStore<K,MV,V>

Throws:

InvalidSubscriberException

asset

public Asset asset()

Specified by:

asset in interface Assetted<KeyValueStore<K,MV,V>>

Returns:

The Asset this resource is associated with.

clear

public void clear()

Specified by:

clear in interface KeyValueStore<K,MV,V>

replace

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

Specified by:

replace in interface KeyValueStore<K,MV,V>

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

put

public boolean put(K key,
                   V value)

Description copied from interface: KeyValueStore

put an entry

Specified by:

put in interface KeyValueStore<K,MV,V>

Parameters:

key - to set

value - to set

Returns:

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

remove

public boolean remove(K key)

Description copied from interface: KeyValueStore

remove a key

Specified by:

remove in interface KeyValueStore<K,MV,V>

Parameters:

key - to remove

Returns:

true if it was removed, false if not.

get

@Nullable
public V get(K key)

Specified by:

get in interface KeyValueStore<K,MV,V>

containsKey

public boolean containsKey(K key)

Specified by:

containsKey in interface KeyValueStore<K,MV,V>

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface KeyValueStore<K,MV,V>

segments

public int segments()

Specified by:

segments in interface KeyValueStore<K,MV,V>

segmentFor

public int segmentFor(K key)

Specified by:

segmentFor in interface KeyValueStore<K,MV,V>

replaceIfEqual

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

Specified by:

replaceIfEqual in interface KeyValueStore<K,MV,V>

removeIfEqual

public boolean removeIfEqual(K key,
                             V value)

Specified by:

removeIfEqual in interface KeyValueStore<K,MV,V>

isKeyType

public boolean isKeyType(Object key)

Specified by:

isKeyType in interface KeyValueStore<K,MV,V>

putIfAbsent

@Nullable
public V putIfAbsent(K key,
                               V value)

Specified by:

putIfAbsent in interface KeyValueStore<K,MV,V>

keyedView

public boolean keyedView()

Description copied from interface: View

If you attach a keyed view to an Asset, it is assumed that any child asset with be a SubAsset.

Specified by:

keyedView in interface KeyValueStore<K,MV,V>

Specified by:

keyedView in interface View

Returns:

Is this a keyed view?

containsValue

public boolean containsValue(V value)

Specified by:

containsValue in interface KeyValueStore<K,MV,V>

keySetIterator

public Iterator<K> keySetIterator()

Specified by:

keySetIterator in interface KeyValueStore<K,MV,V>

keyType

public Class<K> keyType()

valueType

public Class<V> valueType()

accept

public void accept(EngineReplication.ReplicationEntry replicationEntry)

Specified by:

accept in interface java.util.function.Consumer<EngineReplication.ReplicationEntry>