java.lang.Object
- swim.collections.BTreeContext<K,V>
- - swim.collections.BTreeMap<K,V,U>

All Implemented Interfaces:

Cloneable, Iterable<Map.Entry<K,V>>, Map<K,V>, SortedMap<K,V>, Debug, IterableMap<K,V>, OrderedMap<K,V>, ReducedMap<K,V,U>
```
public class BTreeMap<K,V,U>
extends BTreeContext<K,V>
implements ReducedMap<K,V,U>, Cloneable, Debug
```
Mutable, thread-safe Map backed by a B-tree.

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

BTreeMap()

protected BTreeMap(BTreePage<K,V,U> root)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`
`BTreeMap<K,V,U>`	`cleared()`
`BTreeMap<K,V,U>`	`clone()`
`Comparator<? super K>`	`comparator()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`protected BTreeMap<K,V,U>`	`copy(BTreePage<K,V,U> root)`
`<T> Output<T>`	`debug(Output<T> output)`	Writes a developer readable, debug-formatted string representation of this object to `output`.
`BTreeMap<K,V,U>`	`drop(int lower)`
`static <K,V,U> BTreeMap<K,V,U>`	`empty()`
`boolean`	`equals(Object other)`
`Map.Entry<K,V>`	`firstEntry()`
`K`	`firstKey()`
`V`	`firstValue()`
`static <K,V,U> BTreeMap<K,V,U>`	`from(Map<? extends K,? extends V> map)`
`V`	`get(Object key)`
`Map.Entry<K,V>`	`getEntry(Object key)`
`Map.Entry<K,V>`	`getIndex(int index)`
`int`	`hashCode()`
`int`	`indexOf(Object key)`
`boolean`	`isEmpty()`
`OrderedMapCursor<K,V>`	`iterator()`
`Cursor<K>`	`keyIterator()`
`Map.Entry<K,V>`	`lastEntry()`
`K`	`lastKey()`
`V`	`lastValue()`
`Map.Entry<K,V>`	`nextEntry(K key)`
`K`	`nextKey(K key)`
`V`	`nextValue(K key)`
`Map.Entry<K,V>`	`previousEntry(K key)`
`K`	`previousKey(K key)`
`V`	`previousValue(K key)`
`V`	`put(K key, V newValue)`
`void`	`putAll(Map<? extends K,? extends V> map)`
`U`	`reduced(U identity, CombinerFunction<? super V,U> accumulator, CombinerFunction<U,U> combiner)`	Returns the reduction of this `ReducedMap`, combining all contained elements with the given `accumulator` and `combiner` functions, recomputing only what has changed since the last invocation of `reduced`.
`V`	`remove(Object key)`
`BTreeMap<K,V,U>`	`removed(K key)`
`OrderedMapCursor<K,V>`	`reverseIterator()`
`Cursor<K>`	`reverseKeyIterator()`
`Cursor<V>`	`reverseValueIterator()`
`int`	`size()`
`BTree<K,V>`	`snapshot()`	An immutable copy of this `BTreeMap`'s data.
`BTreeMap<K,V,U>`	`take(int upper)`
`String`	`toString()`
`BTreeMap<K,V,U>`	`updated(K key, V newValue)`
`Cursor<V>`	`valueIterator()`

Methods inherited from class swim.collections.BTreeContext
compareKey, pageShouldMerge, pageShouldSplit, pageSplitSize

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface swim.util.OrderedMap
entrySet, headMap, keySet, subMap, tailMap, values

- Constructor Detail
  - BTreeMap
```
protected BTreeMap(BTreePage<K,V,U> root)
```
  - BTreeMap
```
public BTreeMap()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IterableMap<K,V>
    
    Specified by:
    
    isEmpty in interface Map<K,V>
    
    Specified by:
    
    isEmpty in interface OrderedMap<K,V>
  - size
```
public int size()
```
    Specified by:
    
    size in interface IterableMap<K,V>
    
    Specified by:
    
    size in interface Map<K,V>
    
    Specified by:
    
    size in interface OrderedMap<K,V>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface IterableMap<K,V>
    
    Specified by:
    
    containsKey in interface Map<K,V>
    
    Specified by:
    
    containsKey in interface OrderedMap<K,V>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface IterableMap<K,V>
    
    Specified by:
    
    containsValue in interface Map<K,V>
    
    Specified by:
    
    containsValue in interface OrderedMap<K,V>
  - indexOf
```
public int indexOf(Object key)
```
    Specified by:
    
    indexOf in interface OrderedMap<K,V>
  - get
```
public V get(Object key)
```
    Specified by:
    
    get in interface IterableMap<K,V>
    
    Specified by:
    
    get in interface Map<K,V>
    
    Specified by:
    
    get in interface OrderedMap<K,V>
  - getEntry
```
public Map.Entry<K,V> getEntry(Object key)
```
    Specified by:
    
    getEntry in interface OrderedMap<K,V>
  - getIndex
```
public Map.Entry<K,V> getIndex(int index)
```
    Specified by:
    
    getIndex in interface OrderedMap<K,V>
  - firstEntry
```
public Map.Entry<K,V> firstEntry()
```
    Specified by:
    
    firstEntry in interface OrderedMap<K,V>
  - firstKey
```
public K firstKey()
```
    Specified by:
    
    firstKey in interface OrderedMap<K,V>
    
    Specified by:
    
    firstKey in interface SortedMap<K,V>
  - firstValue
```
public V firstValue()
```
    Specified by:
    
    firstValue in interface OrderedMap<K,V>
  - lastEntry
```
public Map.Entry<K,V> lastEntry()
```
    Specified by:
    
    lastEntry in interface OrderedMap<K,V>
  - lastKey
```
public K lastKey()
```
    Specified by:
    
    lastKey in interface OrderedMap<K,V>
    
    Specified by:
    
    lastKey in interface SortedMap<K,V>
  - lastValue
```
public V lastValue()
```
    Specified by:
    
    lastValue in interface OrderedMap<K,V>
  - nextEntry
```
public Map.Entry<K,V> nextEntry(K key)
```
    Specified by:
    
    nextEntry in interface OrderedMap<K,V>
  - nextKey
```
public K nextKey(K key)
```
    Specified by:
    
    nextKey in interface OrderedMap<K,V>
  - nextValue
```
public V nextValue(K key)
```
    Specified by:
    
    nextValue in interface OrderedMap<K,V>
  - previousEntry
```
public Map.Entry<K,V> previousEntry(K key)
```
    Specified by:
    
    previousEntry in interface OrderedMap<K,V>
  - previousKey
```
public K previousKey(K key)
```
    Specified by:
    
    previousKey in interface OrderedMap<K,V>
  - previousValue
```
public V previousValue(K key)
```
    Specified by:
    
    previousValue in interface OrderedMap<K,V>
  - put
```
public V put(K key,
             V newValue)
```
    Specified by:
    
    put in interface IterableMap<K,V>
    
    Specified by:
    
    put in interface Map<K,V>
    
    Specified by:
    
    put in interface OrderedMap<K,V>
  - putAll
```
public void putAll(Map<? extends K,? extends V> map)
```
    Specified by:
    
    putAll in interface IterableMap<K,V>
    
    Specified by:
    
    putAll in interface Map<K,V>
    
    Specified by:
    
    putAll in interface OrderedMap<K,V>
  - remove
```
public V remove(Object key)
```
    Specified by:
    
    remove in interface IterableMap<K,V>
    
    Specified by:
    
    remove in interface Map<K,V>
    
    Specified by:
    
    remove in interface OrderedMap<K,V>
  - drop
```
public BTreeMap<K,V,U> drop(int lower)
```
  - take
```
public BTreeMap<K,V,U> take(int upper)
```
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface IterableMap<K,V>
    
    Specified by:
    
    clear in interface Map<K,V>
    
    Specified by:
    
    clear in interface OrderedMap<K,V>
  - updated
```
public BTreeMap<K,V,U> updated(K key,
                                           V newValue)
```
  - removed
```
public BTreeMap<K,V,U> removed(K key)
```
  - cleared
```
public BTreeMap<K,V,U> cleared()
```
  - reduced
```
public U reduced(U identity,
                 CombinerFunction<? super V,U> accumulator,
                 CombinerFunction<U,U> combiner)
```
    Description copied from interface: ReducedMap
    
    Returns the reduction of this ReducedMap, combining all contained elements with the given accumulator and combiner functions, recomputing only what has changed since the last invocation of reduced. Stores partial computations to accelerate repeated reduction of continuously mutating datasets.
    
    Specified by:
    
    reduced in interface ReducedMap<K,V,U>
  - snapshot
```
public BTree<K,V> snapshot()
```
    An immutable copy of this BTreeMap's data.
  - iterator
```
public OrderedMapCursor<K,V> iterator()
```
    Specified by:
    
    iterator in interface Iterable<K>
    
    Specified by:
    
    iterator in interface IterableMap<K,V>
    
    Specified by:
    
    iterator in interface OrderedMap<K,V>
  - keyIterator
```
public Cursor<K> keyIterator()
```
    Specified by:
    
    keyIterator in interface IterableMap<K,V>
    
    Specified by:
    
    keyIterator in interface OrderedMap<K,V>
  - valueIterator
```
public Cursor<V> valueIterator()
```
    Specified by:
    
    valueIterator in interface IterableMap<K,V>
    
    Specified by:
    
    valueIterator in interface OrderedMap<K,V>
  - reverseIterator
```
public OrderedMapCursor<K,V> reverseIterator()
```
  - reverseKeyIterator
```
public Cursor<K> reverseKeyIterator()
```
  - reverseValueIterator
```
public Cursor<V> reverseValueIterator()
```
  - clone
```
public BTreeMap<K,V,U> clone()
```
    Overrides:
    
    clone in class Object
  - copy
```
protected BTreeMap<K,V,U> copy(BTreePage<K,V,U> root)
```
  - comparator
```
public Comparator<? super K> comparator()
```
    Specified by:
    
    comparator in interface OrderedMap<K,V>
    
    Specified by:
    
    comparator in interface SortedMap<K,V>
  - equals
```
public boolean equals(Object other)
```
    Specified by:
    
    equals in interface Map<K,V>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<K,V>
    
    Overrides:
    
    hashCode in class Object
  - debug
```
public <T> Output<T> debug(Output<T> output)
```
    Description copied from interface: Debug
    
    Writes a developer readable, debug-formatted string representation of this object to output.
    
    Specified by:
    
    debug in interface Debug
    
    Returns:
    
    the continuation of the output.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - empty
```
public static <K,V,U> BTreeMap<K,V,U> empty()
```
  - from
```
public static <K,V,U> BTreeMap<K,V,U> from(Map<? extends K,? extends V> map)
```

Constructors
Modifier	Constructor	Description
	`BTreeMap()`
`protected`	`BTreeMap(BTreePage<K,V,U> root)`

Class BTreeMap<K,​V,​U>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class swim.collections.BTreeContext

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.Map

Methods inherited from interface swim.util.OrderedMap

Constructor Detail

BTreeMap

BTreeMap

Method Detail

isEmpty

size

containsKey

containsValue

indexOf

get

getEntry

getIndex

firstEntry

firstKey

firstValue

lastEntry

lastKey

lastValue

nextEntry

nextKey

nextValue

previousEntry

previousKey

previousValue

put

putAll

remove

drop

take

clear

updated

removed

cleared

reduced

snapshot

iterator

keyIterator

valueIterator

reverseIterator

reverseKeyIterator

reverseValueIterator

clone

copy

comparator

equals

hashCode

debug

toString

empty

from

Class BTreeMap<K,V,U>