Package com.clickhouse.data

Class ClickHouseFreezableMap<K,V>

java.lang.Object

com.clickhouse.data.ClickHouseFreezableMap<K,V>

All Implemented Interfaces:

Map<K,V>

public class ClickHouseFreezableMap<K,V>
extends Object
implements Map<K,V>

Freezable map. Once the map is freezed, all writes will be discarded without any error.

Nested Class Summary

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

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClickHouseFreezableMap(Map<K,V> map, K... keys)

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,V>>	entrySet()
ClickHouseFreezableMap<K,V>	freeze()	Freezes the map to discard write operations.
V	get(Object key)
boolean	isEmpty()
boolean	isFreezed()	Checks whether the map is freezed or not.
protected boolean	isMutable(Object key)	Checks whether the given key can be used in mutation(e.g.
boolean	isWhiteListed(K key)	Checks whether the given key is whitelisted, meaning corresponding entry can be changed even the map is freezed.
Set<K>	keySet()
static <K, V> ClickHouseFreezableMap<K,V>	of(Map<K,V> map, K... whiteListedKeys)	Creates a freezable map with initial data and optional whitelisted keys.
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
V	remove(Object key)
int	size()
ClickHouseFreezableMap<K,V>	unfreeze()	Unfreezes the map to accept write operations.
Collection<V>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Constructor Details

ClickHouseFreezableMap

protected ClickHouseFreezableMap(Map<K,V> map,
 K... keys)

Method Details

of

public static <K,
V> ClickHouseFreezableMap<K,V> of(Map<K,V> map,
 K... whiteListedKeys)

Creates a freezable map with initial data and optional whitelisted keys.

Type Parameters:

K - type of the key

V - type of the value

Parameters:

map - non-null map with initial data

whiteListedKeys - optional whitelisted keys

Returns:

non-null freezable map

isMutable

protected boolean isMutable(Object key)

Checks whether the given key can be used in mutation(e.g. put(), remove()), regardless the map is freezed or not.

Parameters:

key - non-null key

Returns:

true if the given key can be used in mutation; false otherwise

clear

public void clear()

Specified by:

clear 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>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

put

public V put(K key,
 V value)

Specified by:

put in interface Map<K,V>

putAll

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

Specified by:

putAll in interface Map<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

size

public int size()

Specified by:

size in interface Map<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

freeze

public ClickHouseFreezableMap<K,V> freeze()

Freezes the map to discard write operations.

Returns:

this map

unfreeze

public ClickHouseFreezableMap<K,V> unfreeze()

Unfreezes the map to accept write operations.

Returns:

this map

isFreezed

public boolean isFreezed()

Checks whether the map is freezed or not.

Returns:

true if the map is freezed; false otherwise

isWhiteListed

public boolean isWhiteListed(K key)

Checks whether the given key is whitelisted, meaning corresponding entry can be changed even the map is freezed.

Parameters:

key - non-null key

Returns:

true if the key is whitelisted; false otherwise