java.lang.Object
- com.globalmentor.collections.SynchronizedMapDecorator<K,V>

Type Parameters:

K - The type of key used in the map.

V - The type of value stored in the map.

All Implemented Interfaces:

java.util.Map<K,V>

Direct Known Subclasses:

SynchronizedCollectionMapDecorator
```
public class SynchronizedMapDecorator<K,V>
extends java.lang.Object
implements java.util.Map<K,V>
```
A map that wraps an existing map, providing access through the Map interface. All map access is synchronized on the provided synchronization object.

Author:

Garret Wilson

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

Fields
Modifier and Type Field Description

protected java.util.Map<K,V> map
The map this class decorates.

protected java.lang.Object mutex
The mutual exclusion synchronization object.

Constructor Summary

Constructors
Constructor	Description
`SynchronizedMapDecorator(java.util.Map<K,V> map)`	Map constructor.
`SynchronizedMapDecorator(java.util.Map<K,V> map, java.lang.Object mutex)`	Map and mutex constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`
`V`	`compute(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)`
`V`	`computeIfAbsent(K key, java.util.function.Function<? super K,? extends V> mappingFunction)`
`V`	`computeIfPresent(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set<java.util.Map.Entry<K,V>>`	`entrySet()`
`boolean`	`equals(java.lang.Object o)`
`void`	`forEach(java.util.function.BiConsumer<? super K,? super V> action)`
`V`	`get(java.lang.Object key)`
`V`	`getOrDefault(java.lang.Object key, V defaultValue)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`java.util.Set<K>`	`keySet()`
`V`	`merge(K key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)`
`V`	`put(K key, V value)`
`void`	`putAll(java.util.Map<? extends K,? extends V> t)`
`V`	`putIfAbsent(K key, V value)`
`V`	`remove(java.lang.Object key)`
`boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`V`	`replace(K key, V value)`
`boolean`	`replace(K key, V oldValue, V newValue)`
`void`	`replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)`
`int`	`size()`
`java.util.Collection<V>`	`values()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail
- map
```
protected final java.util.Map<K,V> map
```
  The map this class decorates.
- mutex
```
protected final java.lang.Object mutex
```
  The mutual exclusion synchronization object.

Constructor Detail
- SynchronizedMapDecorator
```
public SynchronizedMapDecorator(java.util.Map<K,V> map)
```
  Map constructor. The new instance of this class is used as a mutex.
  
  Parameters:
  
  map - The map this map should decorate.
  
  Throws:
  
  java.lang.NullPointerException - if the provided map is null.
- SynchronizedMapDecorator
```
public SynchronizedMapDecorator(java.util.Map<K,V> map,
                                java.lang.Object mutex)
```
  Map and mutex constructor.
  
  Parameters:
  
  map - The map this map should decorate.
  
  mutex - The mutual exclusion synchronization object.
  
  Throws:
  
  java.lang.NullPointerException - if the provided map and/or mutex is null.

Method Detail

size
```
public int size()
```
Specified by:

size in interface java.util.Map<K,V>

isEmpty
```
public boolean isEmpty()
```
Specified by:

isEmpty in interface java.util.Map<K,V>

containsKey
```
public boolean containsKey(java.lang.Object key)
```
Specified by:

containsKey in interface java.util.Map<K,V>

containsValue
```
public boolean containsValue(java.lang.Object value)
```
Specified by:

containsValue in interface java.util.Map<K,V>

get
```
public V get(java.lang.Object key)
```
Specified by:

get in interface java.util.Map<K,V>

put

public V put(K key,
             V value)

Specified by:: put in interface java.util.Map<K,V>

remove
```
public V remove(java.lang.Object key)
```
Specified by:

remove in interface java.util.Map<K,V>

putAll

public void putAll(java.util.Map<? extends K,? extends V> t)

Specified by:: putAll in interface java.util.Map<K,V>

clear
```
public void clear()
```
Specified by:

clear in interface java.util.Map<K,V>

keySet
```
public java.util.Set<K> keySet()
```
Specified by:

keySet in interface java.util.Map<K,V>

values
```
public java.util.Collection<V> values()
```
Specified by:

values in interface java.util.Map<K,V>

entrySet

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

Specified by:: entrySet in interface java.util.Map<K,V>

equals
```
public boolean equals(java.lang.Object o)
```
Specified by:

equals in interface java.util.Map<K,V>

Overrides:

equals in class java.lang.Object

hashCode
```
public int hashCode()
```
Specified by:

hashCode in interface java.util.Map<K,V>

Overrides:

hashCode in class java.lang.Object

getOrDefault

public V getOrDefault(java.lang.Object key,
                      V defaultValue)

Specified by:: getOrDefault in interface java.util.Map<K,V>

forEach

public void forEach(java.util.function.BiConsumer<? super K,? super V> action)

Specified by:: forEach in interface java.util.Map<K,V>

replaceAll

public void replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)

Specified by:: replaceAll in interface java.util.Map<K,V>

putIfAbsent

public V putIfAbsent(K key,
                     V value)

Specified by:: putIfAbsent in interface java.util.Map<K,V>

remove

public boolean remove(java.lang.Object key,
                      java.lang.Object value)

Specified by:: remove in interface java.util.Map<K,V>

replace

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

Specified by:: replace in interface java.util.Map<K,V>

replace

public V replace(K key,
                 V value)

Specified by:: replace in interface java.util.Map<K,V>

computeIfAbsent

public V computeIfAbsent(K key,
                         java.util.function.Function<? super K,? extends V> mappingFunction)

Specified by:: computeIfAbsent in interface java.util.Map<K,V>

computeIfPresent

public V computeIfPresent(K key,
                          java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)

Specified by:: computeIfPresent in interface java.util.Map<K,V>

compute

public V compute(K key,
                 java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)

Specified by:: compute in interface java.util.Map<K,V>

merge

public V merge(K key,
               V value,
               java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)

Specified by:: merge in interface java.util.Map<K,V>

Modifier and Type	Field	Description
`protected java.util.Map<K,V>`	`map`	The map this class decorates.
`protected java.lang.Object`	`mutex`	The mutual exclusion synchronization object.

Class SynchronizedMapDecorator<K,​V>

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

map

mutex

Constructor Detail

SynchronizedMapDecorator

SynchronizedMapDecorator

Method Detail

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

equals

hashCode

getOrDefault

forEach

replaceAll

putIfAbsent

remove

replace

replace

computeIfAbsent

computeIfPresent

compute

merge

Class SynchronizedMapDecorator<K,V>