software.chronicle.datagrid.internal.map

Class AbstractKeyValueStore<K,V>

java.lang.Object

net.openhft.chronicle.core.io.SimpleCloseable

software.chronicle.datagrid.internal.map.AbstractKeyValueStore<K,V>

All Implemented Interfaces:

Closeable, AutoCloseable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, KeyValueStore<K,V>, Assetted<KeyValueStore<K,V>>, KeyedView

Direct Known Subclasses:

AbstractSubscriptionKeyValueStore, VanillaSubscriptionKeyValueStore

public class AbstractKeyValueStore<K,V>
extends net.openhft.chronicle.core.io.SimpleCloseable
implements KeyValueStore<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface software.chronicle.datagrid.map.KeyValueStore

KeyValueStore.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
@NotNull KeyValueStore<K,V>	kvStore

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT

Method Summary

Modifier and Type	Method and Description
Asset	asset()
void	clear()
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, Object value)
boolean	isKeyType(Object key)
boolean	isReadOnly()
boolean	keyedView() Returns if this is a keyed asset, i.e.
Iterator<K>	keySetIterator()
void	keysFor(int segment, SubscriptionConsumer<K> kConsumer)
Class<K>	keyType()
long	longSize()
protected void	performClose()
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()
@NotNull KeyValueStore<K,V>	underlying()
Class<V>	valueType()

Methods inherited from class net.openhft.chronicle.core.io.SimpleCloseable

close, isClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.chronicle.datagrid.map.KeyValueStore

valuesIterator

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

close, closeQuietly, closeQuietly, notifyClosing, warnAndCloseIfNotClosed

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

isClosed, isClosing, throwExceptionIfClosed

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

referenceId, referenceName, temporary

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

createdHere, throwExceptionIfClosed, warnAndCloseIfNotClosed

Field Detail

kvStore

@NotNull
public final @NotNull KeyValueStore<K,V> kvStore

Method Detail

underlying

@NotNull
public @NotNull KeyValueStore<K,V> underlying()

Specified by:

underlying in interface Assetted<KeyValueStore<K,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,V>

getAndRemove

@Nullable
public V getAndRemove(K key)

Specified by:

getAndRemove in interface KeyValueStore<K,V>

getUsing

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

Specified by:

getUsing in interface KeyValueStore<K,V>

entrySetIterator

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

Specified by:

entrySetIterator in interface KeyValueStore<K,V>

longSize

public long longSize()

Specified by:

longSize in interface KeyValueStore<K,V>

keysFor

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

Specified by:

keysFor in interface KeyValueStore<K,V>

Throws:

InvalidSubscriberException

entriesFor

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

Specified by:

entriesFor in interface KeyValueStore<K,V>

Throws:

InvalidSubscriberException

asset

public Asset asset()

Specified by:

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

Returns:

The Asset this resource is associated with.

clear

public void clear()

Specified by:

clear in interface KeyValueStore<K,V>

replace

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

Specified by:

replace in interface KeyValueStore<K,V>

performClose

protected void performClose()

Overrides:

performClose in class net.openhft.chronicle.core.io.SimpleCloseable

put

public boolean put(K key,
                   V value)

Description copied from interface: KeyValueStore

put an entry

Specified by:

put in interface KeyValueStore<K,V>

Parameters:

key - to set

value - to set

Returns:

true if it was replaced or the value is identical, 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,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,V>

containsKey

public boolean containsKey(K key)

Specified by:

containsKey in interface KeyValueStore<K,V>

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface KeyValueStore<K,V>

segments

public int segments()

Specified by:

segments in interface KeyValueStore<K,V>

segmentFor

public int segmentFor(K key)

Specified by:

segmentFor in interface KeyValueStore<K,V>

replaceIfEqual

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

Specified by:

replaceIfEqual in interface KeyValueStore<K,V>

removeIfEqual

public boolean removeIfEqual(K key,
                             V value)

Specified by:

removeIfEqual in interface KeyValueStore<K,V>

isKeyType

public boolean isKeyType(Object key)

Specified by:

isKeyType in interface KeyValueStore<K,V>

putIfAbsent

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

Specified by:

putIfAbsent in interface KeyValueStore<K,V>

keyedView

public boolean keyedView()

Description copied from interface: KeyedView

Returns if this is a keyed asset, i.e. anything under this must be a SubAsset

Specified by:

keyedView in interface KeyedView

Returns:

if this is a keyed asset, i.e. anything under this must be a SubAsset

containsValue

public boolean containsValue(V value)

Specified by:

containsValue in interface KeyValueStore<K,V>

keySetIterator

public Iterator<K> keySetIterator()

Specified by:

keySetIterator in interface KeyValueStore<K,V>

keyType

public Class<K> keyType()

valueType

public Class<V> valueType()