software.chronicle.datagrid.internal.map

Class VanillaMapView<K,V>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

RemoteMapView, VanillaAuthorisedMapView

public class VanillaMapView<K,V>
extends Object
implements MapView<K,V>

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull Asset	asset
protected @NotNull RequestContext	context
protected Class<K>	keyClass
protected boolean	putReturnsNull
protected boolean	removeReturnsNull
protected Class<V>	valueType

Constructor Summary

Constructors

Constructor and Description
VanillaMapView(@NotNull(exception=java.lang.NullPointerException.class) RequestContext context, @NotNull(exception=java.lang.NullPointerException.class) Asset asset, @NotNull(exception=java.lang.NullPointerException.class) KeyValueStore<K,V> kvStore)

Method Summary

Modifier and Type	Method and Description
@NotNull Asset	asset()
protected void	checkKey(@Nullable Object key)
protected void	checkValue(@Nullable Object value)
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
@NotNull EntrySetView<K,V>	entrySet()
boolean	equals(Object obj)
V	get(Object key)
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 usingValue) Obtain a value using a mutable buffer provided.
int	hashCode()
boolean	isEmpty()
@NotNull KeySetView<K>	keySet()
Class<K>	keyType()
long	longSize()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
V	putIfAbsent(K key, V value)
@NotNull Reference<V>	referenceFor(K key) Obtain a reference the value for a key
void	registerKeySubscriber(@NotNull(exception=java.lang.NullPointerException.class) Subscriber<? super K> subscriber) Add a Subscription for the keys changed on this Map
void	registerKeySubscriber(@NotNull(exception=java.lang.NullPointerException.class) Subscriber<? super K> subscriber, @NotNull(exception=java.lang.NullPointerException.class) Filter filter, @NotNull(exception=java.lang.NullPointerException.class) Set<RequestContext.Operation> operations) Add a Subscription for the keys changed on this Map
void	registerSubscriber(@NotNull(exception=java.lang.NullPointerException.class) Subscriber<? extends MapEvent<? super K,? super V>> subscriber) Add a Subscription for the MapEvents triggered by changes on this Map.
void	registerSubscriber(@NotNull(exception=java.lang.NullPointerException.class) Subscriber<? extends MapEvent<? super K,? super V>> subscriber, @NotNull(exception=java.lang.NullPointerException.class) Filter<? extends MapEvent<? super K,? super V>> filter, @NotNull(exception=java.lang.NullPointerException.class) Set<RequestContext.Operation> operations) Add a Subscription for the MapEvents triggered by changes on this Map.
void	registerTopicSubscriber(@NotNull(exception=java.lang.NullPointerException.class) TopicSubscriber<? super K,? super V> topicSubscriber) Add a TopicSubscriber to this Map.
V	remove(Object key)
boolean	remove(@NotNull(exception=java.lang.NullPointerException.class) Object key, Object value)
V	replace(K key, V value)
boolean	replace(K key, V oldValue, V newValue)
void	set(K key, V value)
@NotNull String	toString()
KeyValueStore<K,V>	underlying()
@NotNull Collection<V>	values()
Class<V>	valueType()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

apply, size

Methods inherited from interface java.util.concurrent.ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll

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

Methods inherited from interface java.util.function.Function

andThen, compose, identity

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

keyedView

Field Detail

keyClass

protected final Class<K> keyClass

valueType

protected final Class<V> valueType

asset

@NotNull
protected final @NotNull Asset asset

context

@NotNull
protected final @NotNull RequestContext context

putReturnsNull

protected final boolean putReturnsNull

removeReturnsNull

protected final boolean removeReturnsNull

Constructor Detail

VanillaMapView

public VanillaMapView(@NotNull(exception=java.lang.NullPointerException.class)
                      @NotNull(exception=java.lang.NullPointerException.class) RequestContext context,
                      @NotNull(exception=java.lang.NullPointerException.class)
                      @NotNull(exception=java.lang.NullPointerException.class) Asset asset,
                      @NotNull(exception=java.lang.NullPointerException.class)
                      @NotNull(exception=java.lang.NullPointerException.class) KeyValueStore<K,V> kvStore)

Method Detail

keyType

public Class<K> keyType()

Specified by:

keyType in interface MapView<K,V>

Returns:

the type of the keys

valueType

public Class<V> valueType()

Specified by:

valueType in interface MapView<K,V>

Returns:

the type of the values.

getUsing

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

Description copied from interface: MapView

Obtain a value using a mutable buffer provided.

Specified by:

getUsing in interface MapView<K,V>

Parameters:

key - to lookup.

usingValue - a mutable buffer

Returns:

the value.

keySet

@NotNull
public @NotNull KeySetView<K> keySet()

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface MapView<K,V>

values

@NotNull
public @NotNull Collection<V> values()

Specified by:

values in interface Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

checkKey

protected void checkKey(@Nullable
                        @Nullable Object key)

checkValue

protected void checkValue(@Nullable
                          @Nullable Object value)

asset

@NotNull
public @NotNull Asset asset()

Specified by:

asset in interface Assetted<Object>

Returns:

The Asset this resource is associated with.

underlying

public KeyValueStore<K,V> underlying()

Specified by:

underlying in interface Assetted<Object>

Returns:

The Underlying view this view is built on.

get

@Nullable
public V get(Object key)

Specified by:

get in interface Map<K,V>

Specified by:

get in interface KeyedVisitable<K,V>

Parameters:

key - to get within this collection.

Returns:

the current state of a visitable Asset

put

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

Specified by:

put in interface Map<K,V>

set

public void set(K key,
                V value)

Specified by:

set in interface KeyedVisitable<K,V>

Parameters:

key - to set within this collection.

value - replace the current state of the visitable Asset

remove

@Nullable
public V remove(Object key)

Specified by:

remove in interface Map<K,V>

putAll

public void putAll(Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

longSize

public long longSize()

Specified by:

longSize in interface MapView<K,V>

Returns:

the size as a long value.

getAndPut

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

Description copied from interface: MapView

Explicitly get the old value before putting a new one.

Specified by:

getAndPut in interface MapView<K,V>

Parameters:

key - to lookup

value - to set

Returns:

the old value or null if absent

getAndRemove

@Nullable
public V getAndRemove(K key)

Description copied from interface: MapView

Explicitly get the old value before removing.

Specified by:

getAndRemove in interface MapView<K,V>

Parameters:

key - to remove

Returns:

the old value or null if absent.

entrySet

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

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface MapView<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

putIfAbsent

@Nullable
public V putIfAbsent(@NotNull(exception=java.lang.NullPointerException.class)
                               K key,
                               V value)

Specified by:

putIfAbsent in interface ConcurrentMap<K,V>

Specified by:

putIfAbsent in interface Map<K,V>

remove

public boolean remove(@NotNull(exception=java.lang.NullPointerException.class)
                      @NotNull(exception=java.lang.NullPointerException.class) Object key,
                      Object value)

Specified by:

remove in interface ConcurrentMap<K,V>

Specified by:

remove in interface Map<K,V>

replace

public boolean replace(@NotNull(exception=java.lang.NullPointerException.class)
                       K key,
                       @NotNull(exception=java.lang.NullPointerException.class)
                       V oldValue,
                       @NotNull(exception=java.lang.NullPointerException.class)
                       V newValue)

Specified by:

replace in interface ConcurrentMap<K,V>

Specified by:

replace in interface Map<K,V>

replace

@Nullable
public V replace(@NotNull(exception=java.lang.NullPointerException.class)
                           K key,
                           @NotNull(exception=java.lang.NullPointerException.class)
                           V value)

Specified by:

replace in interface ConcurrentMap<K,V>

Specified by:

replace in interface Map<K,V>

registerTopicSubscriber

public void registerTopicSubscriber(@NotNull(exception=java.lang.NullPointerException.class)
                                    @NotNull(exception=java.lang.NullPointerException.class) TopicSubscriber<? super K,? super V> topicSubscriber)

Description copied from interface: MapView

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.

Specified by:

registerTopicSubscriber in interface MapView<K,V>

Parameters:

topicSubscriber - to add

registerKeySubscriber

public void registerKeySubscriber(@NotNull(exception=java.lang.NullPointerException.class)
                                  @NotNull(exception=java.lang.NullPointerException.class) Subscriber<? super K> subscriber)

Description copied from interface: MapView

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.

Specified by:

registerKeySubscriber in interface MapView<K,V>

Parameters:

subscriber - to add

registerKeySubscriber

public void registerKeySubscriber(@NotNull(exception=java.lang.NullPointerException.class)
                                  @NotNull(exception=java.lang.NullPointerException.class) Subscriber<? super K> subscriber,
                                  @NotNull(exception=java.lang.NullPointerException.class)
                                  @NotNull(exception=java.lang.NullPointerException.class) Filter filter,
                                  @NotNull(exception=java.lang.NullPointerException.class)
                                  @NotNull(exception=java.lang.NullPointerException.class) Set<RequestContext.Operation> operations)

Description copied from interface: MapView

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.

Specified by:

registerKeySubscriber in interface MapView<K,V>

Parameters:

subscriber - to add

filter - a list of filter operations

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

registerSubscriber

public void registerSubscriber(@NotNull(exception=java.lang.NullPointerException.class)
                               @NotNull(exception=java.lang.NullPointerException.class) Subscriber<? extends MapEvent<? super K,? super V>> subscriber)

Description copied from interface: MapView

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.

Specified by:

registerSubscriber in interface MapView<K,V>

Parameters:

subscriber - the subscriber to the subscription

registerSubscriber

public void registerSubscriber(@NotNull(exception=java.lang.NullPointerException.class)
                               @NotNull(exception=java.lang.NullPointerException.class) Subscriber<? extends MapEvent<? super K,? super V>> subscriber,
                               @NotNull(exception=java.lang.NullPointerException.class)
                               @NotNull(exception=java.lang.NullPointerException.class) Filter<? extends MapEvent<? super K,? super V>> filter,
                               @NotNull(exception=java.lang.NullPointerException.class)
                               @NotNull(exception=java.lang.NullPointerException.class) Set<RequestContext.Operation> operations)

Description copied from interface: MapView

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.

Specified by:

registerSubscriber in interface MapView<K,V>

Parameters:

subscriber - the subscriber to the subscription

filter - to apply on keys and values

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

referenceFor

@NotNull
public @NotNull Reference<V> referenceFor(K key)

Description copied from interface: MapView

Obtain a reference the value for a key

Specified by:

referenceFor in interface MapView<K,V>

Parameters:

key - to bind the reference to

Returns:

a reference object.

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object