software.chronicle.datagrid.map

Interface MapView<K,V>

All Superinterfaces:

Assetted<Object>, ConcurrentMap<K,V>, Function<K,V>, KeyedView, KeyedVisitable<K,V>, Map<K,V>, Updatable<MapView<K,V>>

All Known Implementing Classes:

AuthorisedChronicleQueueView, ChronicleQueueView, RemoteMapView, VanillaAuthorisedMapView, VanillaMapView

public interface MapView<K,V>
extends ConcurrentMap<K,V>, Assetted<Object>, Updatable<MapView<K,V>>, KeyedVisitable<K,V>, Function<K,V>, KeyedView

Interface for Map views.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
default V	apply(K k)
@NotNull EntrySetView<K,V>	entrySet()
V	getAndPut(K key, V value) Explicitly get the old value before putting a new one.
V	getAndRemove(K key) Explicitly get the old value before removing.
V	getUsing(K key, Object using) Obtain a value using a mutable buffer provided.
@NotNull KeySetView<K>	keySet()
Class<K>	keyType()
long	longSize()
Reference<V>	referenceFor(K key) Obtain a reference the value for a key
void	registerKeySubscriber(@NotNull Subscriber<? super K> subscriber) Add a Subscription for the keys changed on this Map
void	registerKeySubscriber(@NotNull Subscriber<? super K> subscriber, @NotNull Filter filter, @NotNull Set<RequestContext.Operation> contextOperations) Add a Subscription for the keys changed on this Map
void	registerSubscriber(@NotNull Subscriber<? extends MapEvent<? super K,? super V>> subscriber) Add a Subscription for the MapEvents triggered by changes on this Map.
void	registerSubscriber(@NotNull Subscriber<? extends MapEvent<? super K,? super V>> subscriber, @NotNull Filter<? extends MapEvent<? super K,? super V>> filter, @NotNull Set<RequestContext.Operation> contextOperations) Add a Subscription for the MapEvents triggered by changes on this Map.
void	registerTopicSubscriber(@NotNull TopicSubscriber<? super K,? super V> topicSubscriber) Add a TopicSubscriber to this Map.
default int	size()
Class<V>	valueType()

Methods inherited from interface java.util.concurrent.ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, remove, values

Methods inherited from interface software.chronicle.datagrid.tree.Assetted

asset, underlying

Methods inherited from interface software.chronicle.datagrid.collection.Updatable

applyTo, applyTo, asyncUpdate, asyncUpdate, syncUpdate, syncUpdate

Methods inherited from interface software.chronicle.datagrid.collection.KeyedVisitable

applyToKey, applyToKey, asyncUpdateKey, asyncUpdateKey, get, set, syncUpdateKey, syncUpdateKey

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Methods inherited from interface software.chronicle.datagrid.tree.KeyedView

keyedView

Method Detail

keySet

@NotNull
@NotNull KeySetView<K> keySet()

Specified by:

keySet in interface Map<K,V>

entrySet

@NotNull
@NotNull EntrySetView<K,V> entrySet()

Specified by:

entrySet in interface Map<K,V>

getUsing

@Nullable
V getUsing(K key,
                     Object using)

Obtain a value using a mutable buffer provided.

Parameters:

key - to lookup.

using - a mutable buffer

Returns:

the value.

registerTopicSubscriber

void registerTopicSubscriber(@NotNull
                             @NotNull TopicSubscriber<? super K,? super V> topicSubscriber)

Add a TopicSubscriber to this Map.

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Parameters:

topicSubscriber - to add

registerKeySubscriber

void registerKeySubscriber(@NotNull
                           @NotNull Subscriber<? super K> subscriber)

Add a Subscription for the keys changed on this Map

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Parameters:

subscriber - to add

registerKeySubscriber

void registerKeySubscriber(@NotNull
                           @NotNull Subscriber<? super K> subscriber,
                           @NotNull
                           @NotNull Filter filter,
                           @NotNull
                           @NotNull Set<RequestContext.Operation> contextOperations)

Add a Subscription for the keys changed on this Map

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Parameters:

subscriber - to add

filter - a list of filter operations

contextOperations - which optional operations to consider (e.g. bootstrap and ending after bootstrap)

registerSubscriber

void registerSubscriber(@NotNull
                        @NotNull Subscriber<? extends MapEvent<? super K,? super V>> subscriber)

Add a Subscription for the MapEvents triggered by changes on this Map.

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Parameters:

subscriber - the subscriber to the subscription

registerSubscriber

void registerSubscriber(@NotNull
                        @NotNull Subscriber<? extends MapEvent<? super K,? super V>> subscriber,
                        @NotNull
                        @NotNull Filter<? extends MapEvent<? super K,? super V>> filter,
                        @NotNull
                        @NotNull Set<RequestContext.Operation> contextOperations)

Add a Subscription for the MapEvents triggered by changes on this Map.

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Parameters:

subscriber - the subscriber to the subscription

filter - to apply on keys and values

contextOperations - which optional operations to consider (e.g. bootstrap and ending after bootstrap)

referenceFor

Reference<V> referenceFor(K key)

Obtain a reference the value for a key

Parameters:

key - to bind the reference to

Returns:

a reference object.

keyType

Class<K> keyType()

Returns:

the type of the keys

valueType

Class<V> valueType()

Returns:

the type of the values.

apply

@Nullable
default V apply(K k)

Specified by:

apply in interface Function<K,V>

size

default int size()

Specified by:

size in interface Map<K,V>

longSize

long longSize()

Returns:

the size as a long value.

getAndPut

@Nullable
V getAndPut(K key,
                      V value)

Explicitly get the old value before putting a new one.

Parameters:

key - to lookup

value - to set

Returns:

the old value or null if absent

getAndRemove

@Nullable
V getAndRemove(K key)

Explicitly get the old value before removing.

Parameters:

key - to remove

Returns:

the old value or null if absent.