AbstractCopyOnWriteMap

java.lang.Object
- org.bson.util.AbstractCopyOnWriteMap<K,V,M>

Type Parameters:

K - The key type

V - The value type

M - the internal Map or extension for things like sorted and navigable maps.

All Implemented Interfaces:

java.util.concurrent.ConcurrentMap<K,V>, java.util.Map<K,V>

Direct Known Subclasses:

CopyOnWriteMap
```
@ThreadSafe
abstract class AbstractCopyOnWriteMap<K,V,M extends java.util.Map<K,V>>
extends java.lang.Object
implements java.util.concurrent.ConcurrentMap<K,V>
```
Abstract base class for COW Map implementations that delegate to an internal map.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AbstractCopyOnWriteMap.CollectionView<E>`
`private class`	`AbstractCopyOnWriteMap.EntrySet`
`(package private) class`	`AbstractCopyOnWriteMap.Immutable`
`private class`	`AbstractCopyOnWriteMap.KeySet`
`(package private) class`	`AbstractCopyOnWriteMap.Mutable`
`private static class`	`AbstractCopyOnWriteMap.UnmodifiableIterator<T>`
`private class`	`AbstractCopyOnWriteMap.Values`
`static class`	`AbstractCopyOnWriteMap.View<K,V>` Provides access to the views of the underlying key, value and entry collections.

Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>

Field Summary

Fields
Modifier and Type Field and Description

private M delegate

private java.util.concurrent.locks.Lock lock

private AbstractCopyOnWriteMap.View<K,V> view

Fields
Modifier and Type	Field and Description
`private M`	`delegate`
`private java.util.concurrent.locks.Lock`	`lock`
`private AbstractCopyOnWriteMap.View<K,V>`	`view`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractCopyOnWriteMap(N map, AbstractCopyOnWriteMap.View.Type viewType)` Create a new `CopyOnWriteMap` with the supplied `Map` to initialize the values.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`protected M`	`copy()`
`(package private) abstract <N extends java.util.Map<? extends K,? extends V>> M`	`copy(N map)` Copy function, implemented by sub-classes.
`java.util.Set<java.util.Map.Entry<K,V>>`	`entrySet()`
`boolean`	`equals(java.lang.Object o)`
`private boolean`	`equals(java.lang.Object o1, java.lang.Object o2)`
`V`	`get(java.lang.Object key)`
`protected M`	`getDelegate()`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`java.util.Set<K>`	`keySet()`
`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)`
`protected void`	`set(M map)`
`int`	`size()`
`java.lang.String`	`toString()`
`java.util.Collection<V>`	`values()`

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

Methods inherited from interface java.util.concurrent.ConcurrentMap
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll

- Field Detail
  - delegate
```
private volatile M extends java.util.Map<K,V> delegate
```
  - lock
```
private final transient java.util.concurrent.locks.Lock lock
```
  - view
```
private final AbstractCopyOnWriteMap.View<K,V> view
```
- Constructor Detail
  - AbstractCopyOnWriteMap
```
protected AbstractCopyOnWriteMap(N map,
                                 AbstractCopyOnWriteMap.View.Type viewType)
```
    Create a new CopyOnWriteMap with the supplied Map to initialize the values.
    
    Parameters:
    
    map - the initial map to initialize with
    
    viewType - for writable or read-only key, value and entrySet views
- Method Detail
  - copy
```
abstract <N extends java.util.Map<? extends K,? extends V>> M copy(N map)
```
    Copy function, implemented by sub-classes.
    
    Type Parameters:
    
    N - the map to copy and return.
    
    Parameters:
    
    map - the initial values of the newly created map.
    
    Returns:
    
    a new map. Will never be modified after construction.
  - clear
```
public final void clear()
```
    Specified by:
    
    clear in interface java.util.Map<K,V>
  - remove
```
public final V remove(java.lang.Object key)
```
    Specified by:
    
    remove 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.concurrent.ConcurrentMap<K,V>
    
    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.concurrent.ConcurrentMap<K,V>
    
    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.concurrent.ConcurrentMap<K,V>
    
    Specified by:
    
    replace in interface java.util.Map<K,V>
  - put
```
public final V put(K key,
                   V value)
```
    Specified by:
    
    put in interface java.util.Map<K,V>
  - putIfAbsent
```
public V putIfAbsent(K key,
                     V value)
```
    Specified by:
    
    putIfAbsent in interface java.util.concurrent.ConcurrentMap<K,V>
    
    Specified by:
    
    putIfAbsent in interface java.util.Map<K,V>
  - putAll
```
public final void putAll(java.util.Map<? extends K,? extends V> t)
```
    Specified by:
    
    putAll in interface java.util.Map<K,V>
  - copy
```
protected M copy()
```
  - set
```
protected void set(M map)
```
  - entrySet
```
public final java.util.Set<java.util.Map.Entry<K,V>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<K,V>
  - keySet
```
public final java.util.Set<K> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<K,V>
  - values
```
public final java.util.Collection<V> values()
```
    Specified by:
    
    values in interface java.util.Map<K,V>
  - containsKey
```
public final boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<K,V>
  - containsValue
```
public final boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<K,V>
  - get
```
public final V get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<K,V>
  - isEmpty
```
public final boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<K,V>
  - size
```
public final int size()
```
    Specified by:
    
    size in interface java.util.Map<K,V>
  - equals
```
public final 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 final int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map<K,V>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - getDelegate
```
protected final M getDelegate()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
private boolean equals(java.lang.Object o1,
                       java.lang.Object o2)
```

Class AbstractCopyOnWriteMap<K,V,M extends java.util.Map<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

Methods inherited from interface java.util.concurrent.ConcurrentMap

Field Detail

delegate

lock

view

Constructor Detail

AbstractCopyOnWriteMap

Method Detail

copy

clear

remove

remove

replace

replace

put

putIfAbsent

putAll

copy

set

entrySet

keySet

values

containsKey

containsValue

get

isEmpty

size

equals

hashCode

getDelegate

toString

equals