CopyOnWriteArrayMap (Apache HBase 1.2.12 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - org.apache.hadoop.hbase.types.CopyOnWriteArrayMap<K,V>

All Implemented Interfaces:

ConcurrentMap<K,V>, ConcurrentNavigableMap<K,V>, Map<K,V>, NavigableMap<K,V>, SortedMap<K,V>
```
@InterfaceAudience.Private
@InterfaceStability.Stable
public class CopyOnWriteArrayMap<K,V>
extends AbstractMap<K,V>
implements Map<K,V>, ConcurrentNavigableMap<K,V>
```
A Map that keeps a sorted array in order to provide the concurrent map interface. Keeping a sorted array means that it's much more cache line friendly, making reads faster than the tree version. In order to make concurrent reads and writes safe this does a copy on write. There can only be one concurrent write at a time.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`CopyOnWriteArrayMap.ArrayEntryIterator<K,V>`
`private class`	`CopyOnWriteArrayMap.ArrayEntrySet<K,V>`
`private static class`	`CopyOnWriteArrayMap.ArrayHolder<K,V>`
`private class`	`CopyOnWriteArrayMap.ArrayKeyIterator<K,V>`
`private class`	`CopyOnWriteArrayMap.ArrayKeySet<K,V>`
`private class`	`CopyOnWriteArrayMap.ArrayValueCollection<K,V>`
`private class`	`CopyOnWriteArrayMap.ArrayValueIterator<K,V>`
`private static class`	`CopyOnWriteArrayMap.COWEntry<K,V>`

Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Field Summary

Fields
Modifier and Type Field and Description

private CopyOnWriteArrayMap.ArrayHolder<K,V> holder

private Comparator<? super K> keyComparator

Fields
Modifier and Type	Field and Description
`private CopyOnWriteArrayMap.ArrayHolder<K,V>`	`holder`
`private Comparator<? super K>`	`keyComparator`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CopyOnWriteArrayMap()`
	`CopyOnWriteArrayMap(Comparator<? super K> keyComparator)`
`private`	`CopyOnWriteArrayMap(Comparator<? super K> keyComparator, CopyOnWriteArrayMap.ArrayHolder<K,V> holder)`

Method Summary

Methods
Modifier and Type	Method and Description
`Map.Entry<K,V>`	`ceilingEntry(K key)`
`K`	`ceilingKey(K key)`
`void`	`clear()`
`Comparator<? super K>`	`comparator()`
`boolean`	`containsKey(Object key)`
`NavigableSet<K>`	`descendingKeySet()`
`ConcurrentNavigableMap<K,V>`	`descendingMap()`
`Set<Map.Entry<K,V>>`	`entrySet()`
`Map.Entry<K,V>`	`firstEntry()`
`K`	`firstKey()`
`Map.Entry<K,V>`	`floorEntry(K key)`
`K`	`floorKey(K key)`
`V`	`get(Object key)`
`ConcurrentNavigableMap<K,V>`	`headMap(K toKey)`
`ConcurrentNavigableMap<K,V>`	`headMap(K toKey, boolean inclusive)`
`Map.Entry<K,V>`	`higherEntry(K key)`
`K`	`higherKey(K key)`
`boolean`	`isEmpty()`
`NavigableSet<K>`	`keySet()`
`Map.Entry<K,V>`	`lastEntry()`
`K`	`lastKey()`
`Map.Entry<K,V>`	`lowerEntry(K key)`
`K`	`lowerKey(K key)`
`NavigableSet<K>`	`navigableKeySet()`
`Map.Entry<K,V>`	`pollFirstEntry()`
`Map.Entry<K,V>`	`pollLastEntry()`
`V`	`put(K key, V value)`
`V`	`putIfAbsent(K key, V value)`
`V`	`remove(Object key)`
`boolean`	`remove(Object key, Object value)`
`V`	`replace(K key, V value)`
`boolean`	`replace(K key, V oldValue, V newValue)`
`int`	`size()`
`ConcurrentNavigableMap<K,V>`	`subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)`
`ConcurrentNavigableMap<K,V>`	`subMap(K fromKey, K toKey)`
`ConcurrentNavigableMap<K,V>`	`tailMap(K fromKey)`
`ConcurrentNavigableMap<K,V>`	`tailMap(K fromKey, boolean inclusive)`
`Collection<V>`	`values()`

Methods inherited from class java.util.AbstractMap
clone, containsValue, equals, hashCode, putAll, toString

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

Methods inherited from interface java.util.Map
containsValue, equals, hashCode, putAll

- Field Detail
  - keyComparator
```
private final Comparator<? super K> keyComparator
```
  - holder
```
private volatile CopyOnWriteArrayMap.ArrayHolder<K,V> holder
```
- Constructor Detail
  - CopyOnWriteArrayMap
```
public CopyOnWriteArrayMap()
```
  - CopyOnWriteArrayMap
```
public CopyOnWriteArrayMap(Comparator<? super K> keyComparator)
```
  - CopyOnWriteArrayMap
```
private CopyOnWriteArrayMap(Comparator<? super K> keyComparator,
                   CopyOnWriteArrayMap.ArrayHolder<K,V> holder)
```
- Method Detail
  - comparator
```
public Comparator<? super K> comparator()
```
    Specified by:
    
    comparator in interface SortedMap<K,V>
  - tailMap
```
public ConcurrentNavigableMap<K,V> tailMap(K fromKey,
                                  boolean inclusive)
```
    Specified by:
    
    tailMap in interface ConcurrentNavigableMap<K,V>
    
    Specified by:
    
    tailMap in interface NavigableMap<K,V>
  - tailMap
```
public ConcurrentNavigableMap<K,V> tailMap(K fromKey)
```
    Specified by:
    
    tailMap in interface ConcurrentNavigableMap<K,V>
    
    Specified by:
    
    tailMap in interface NavigableMap<K,V>
    
    Specified by:
    
    tailMap in interface SortedMap<K,V>
  - firstKey
```
public K firstKey()
```
    Specified by:
    
    firstKey in interface SortedMap<K,V>
  - lastKey
```
public K lastKey()
```
    Specified by:
    
    lastKey in interface SortedMap<K,V>
  - lowerEntry
```
public Map.Entry<K,V> lowerEntry(K key)
```
    Specified by:
    
    lowerEntry in interface NavigableMap<K,V>
  - lowerKey
```
public K lowerKey(K key)
```
    Specified by:
    
    lowerKey in interface NavigableMap<K,V>
  - floorEntry
```
public Map.Entry<K,V> floorEntry(K key)
```
    Specified by:
    
    floorEntry in interface NavigableMap<K,V>
  - floorKey
```
public K floorKey(K key)
```
    Specified by:
    
    floorKey in interface NavigableMap<K,V>
  - ceilingEntry
```
public Map.Entry<K,V> ceilingEntry(K key)
```
    Specified by:
    
    ceilingEntry in interface NavigableMap<K,V>
  - ceilingKey
```
public K ceilingKey(K key)
```
    Specified by:
    
    ceilingKey in interface NavigableMap<K,V>
  - higherEntry
```
public Map.Entry<K,V> higherEntry(K key)
```
    Specified by:
    
    higherEntry in interface NavigableMap<K,V>
  - higherKey
```
public K higherKey(K key)
```
    Specified by:
    
    higherKey in interface NavigableMap<K,V>
  - firstEntry
```
public Map.Entry<K,V> firstEntry()
```
    Specified by:
    
    firstEntry in interface NavigableMap<K,V>
  - lastEntry
```
public Map.Entry<K,V> lastEntry()
```
    Specified by:
    
    lastEntry in interface NavigableMap<K,V>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<K,V>
    
    Overrides:
    
    size in class AbstractMap<K,V>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<K,V>
    
    Overrides:
    
    isEmpty in class AbstractMap<K,V>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<K,V>
    
    Overrides:
    
    containsKey in class AbstractMap<K,V>
  - get
```
public V get(Object key)
```
    Specified by:
    
    get in interface Map<K,V>
    
    Overrides:
    
    get in class AbstractMap<K,V>
  - keySet
```
public NavigableSet<K> keySet()
```
    Specified by:
    
    keySet in interface ConcurrentNavigableMap<K,V>
    
    Specified by:
    
    keySet in interface Map<K,V>
    
    Specified by:
    
    keySet in interface SortedMap<K,V>
    
    Overrides:
    
    keySet in class AbstractMap<K,V>
  - values
```
public Collection<V> values()
```
    Specified by:
    
    values in interface Map<K,V>
    
    Specified by:
    
    values in interface SortedMap<K,V>
    
    Overrides:
    
    values in class AbstractMap<K,V>
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<K,V>
    
    Specified by:
    
    entrySet in interface SortedMap<K,V>
    
    Specified by:
    
    entrySet in class AbstractMap<K,V>
  - put
```
public V put(K key,
    V value)
```
    Specified by:
    
    put in interface Map<K,V>
    
    Overrides:
    
    put in class AbstractMap<K,V>
  - remove
```
public V remove(Object key)
```
    Specified by:
    
    remove in interface Map<K,V>
    
    Overrides:
    
    remove in class AbstractMap<K,V>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<K,V>
    
    Overrides:
    
    clear in class AbstractMap<K,V>
  - putIfAbsent
```
public V putIfAbsent(K key,
            V value)
```
    Specified by:
    
    putIfAbsent in interface ConcurrentMap<K,V>
  - remove
```
public boolean remove(Object key,
             Object value)
```
    Specified by:
    
    remove in interface ConcurrentMap<K,V>
  - replace
```
public boolean replace(K key,
              V oldValue,
              V newValue)
```
    Specified by:
    
    replace in interface ConcurrentMap<K,V>
  - replace
```
public V replace(K key,
        V value)
```
    Specified by:
    
    replace in interface ConcurrentMap<K,V>
  - pollFirstEntry
```
public Map.Entry<K,V> pollFirstEntry()
```
    Specified by:
    
    pollFirstEntry in interface NavigableMap<K,V>
  - pollLastEntry
```
public Map.Entry<K,V> pollLastEntry()
```
    Specified by:
    
    pollLastEntry in interface NavigableMap<K,V>
  - descendingMap
```
public ConcurrentNavigableMap<K,V> descendingMap()
```
    Specified by:
    
    descendingMap in interface ConcurrentNavigableMap<K,V>
    
    Specified by:
    
    descendingMap in interface NavigableMap<K,V>
  - navigableKeySet
```
public NavigableSet<K> navigableKeySet()
```
    Specified by:
    
    navigableKeySet in interface ConcurrentNavigableMap<K,V>
    
    Specified by:
    
    navigableKeySet in interface NavigableMap<K,V>
  - subMap
```
public ConcurrentNavigableMap<K,V> subMap(K fromKey,
                                 K toKey)
```
    Specified by:
    
    subMap in interface ConcurrentNavigableMap<K,V>
    
    Specified by:
    
    subMap in interface NavigableMap<K,V>
    
    Specified by:
    
    subMap in interface SortedMap<K,V>
  - headMap
```
public ConcurrentNavigableMap<K,V> headMap(K toKey)
```
    Specified by:
    
    headMap in interface ConcurrentNavigableMap<K,V>
    
    Specified by:
    
    headMap in interface NavigableMap<K,V>
    
    Specified by:
    
    headMap in interface SortedMap<K,V>
  - subMap
```
public ConcurrentNavigableMap<K,V> subMap(K fromKey,
                                 boolean fromInclusive,
                                 K toKey,
                                 boolean toInclusive)
```
    Specified by:
    
    subMap in interface ConcurrentNavigableMap<K,V>
    
    Specified by:
    
    subMap in interface NavigableMap<K,V>
  - headMap
```
public ConcurrentNavigableMap<K,V> headMap(K toKey,
                                  boolean inclusive)
```
    Specified by:
    
    headMap in interface ConcurrentNavigableMap<K,V>
    
    Specified by:
    
    headMap in interface NavigableMap<K,V>
  - descendingKeySet
```
public NavigableSet<K> descendingKeySet()
```
    Specified by:
    
    descendingKeySet in interface ConcurrentNavigableMap<K,V>
    
    Specified by:
    
    descendingKeySet in interface NavigableMap<K,V>

Class CopyOnWriteArrayMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

keyComparator

holder

Constructor Detail

CopyOnWriteArrayMap

CopyOnWriteArrayMap

CopyOnWriteArrayMap

Method Detail

comparator

tailMap

tailMap

firstKey

lastKey

lowerEntry

lowerKey

floorEntry

floorKey

ceilingEntry

ceilingKey

higherEntry

higherKey

firstEntry

lastEntry

size

isEmpty

containsKey

get

keySet

values

entrySet

put

remove

clear

putIfAbsent

remove

replace

replace

pollFirstEntry

pollLastEntry

descendingMap

navigableKeySet

subMap

headMap

subMap

headMap

descendingKeySet