Package io.permazen.kv.util

Class KVNavigableMap

java.lang.Object

java.util.AbstractMap<K,V>

io.permazen.util.AbstractNavigableMap<K,V>

io.permazen.kv.util.AbstractKVNavigableMap<ByteData,ByteData>

io.permazen.kv.util.KVNavigableMap

All Implemented Interfaces:

Map<ByteData,ByteData>, NavigableMap<ByteData,ByteData>, SortedMap<ByteData,ByteData>

public class KVNavigableMap
extends AbstractKVNavigableMap<ByteData,ByteData>

A NavigableMap view of the keys and values in a KVStore.

Instances are mutable, with these exceptions:

• clear() is not supported when a KeyFilter is configured

Nested Class Summary

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

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

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

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

Field Summary

Fields inherited from class io.permazen.kv.util.AbstractKVNavigableMap

keyFilter, keyRange, kv, prefixMode, reversed

Fields inherited from class io.permazen.util.AbstractNavigableMap

bounds

Constructor Summary

Constructors

Modifier	Constructor	Description
	KVNavigableMap(KVStore kv)	Constructor for when there are no range restrictions.
protected	KVNavigableMap(KVStore kv, boolean reversed, KeyRange keyRange, KeyFilter keyFilter)	Primary constructor.
	KVNavigableMap(KVStore kv, ByteData prefix)	Constructor for when the range of visible KVStore keys is all keys sharing a given byte[] prefix.

Method Summary

Modifier and Type	Method	Description
void	clear()
Comparator<ByteData>	comparator()
boolean	containsKey(Object obj)
protected NavigableMap<ByteData,ByteData>	createSubMap(boolean newReversed, KeyRange newKeyRange, KeyFilter newKeyFilter, Bounds<ByteData> newBounds)	Create a (possibly reversed) view of this instance with (possibly) tighter lower and/or upper bounds and the given KeyFilter, if any.
protected ByteData	decodeKey(ByteData.Reader reader)	Decode a key object from an encoded byte[] key.
protected ByteData	decodeValue(KVPair pair)	Decode a value object from an encoded byte[] key/value pair.
protected void	encodeKey(ByteData.Writer writer, Object obj)	Encode the given key object into a byte[] key.
ByteData	put(ByteData key, ByteData value)
ByteData	remove(Object obj)	Removes the mapping for a key from this map if it is present.

Methods inherited from class io.permazen.kv.util.AbstractKVNavigableMap

createSubMap, encodeVisibleKey, entrySet, filterKeys, get, isVisible, isWithinLowerBound, isWithinUpperBound, navigableKeySet

Methods inherited from class io.permazen.util.AbstractNavigableMap

ceilingEntry, ceilingKey, descendingKeySet, descendingMap, firstEntry, firstKey, floorEntry, floorKey, getBounds, getComparator, headMap, headMap, higherEntry, higherKey, isEmpty, keySet, lastEntry, lastKey, lowerEntry, lowerKey, pollFirstEntry, pollLastEntry, searchAbove, searchBelow, subMap, subMap, tailMap, tailMap

Methods inherited from class java.util.AbstractMap

clone, containsValue, equals, hashCode, putAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

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

Methods inherited from interface java.util.SortedMap

values

Constructor Details

KVNavigableMap

public KVNavigableMap(KVStore kv)

Constructor for when there are no range restrictions.

Parameters:

kv - underlying KVStore

KVNavigableMap

public KVNavigableMap(KVStore kv,
 ByteData prefix)

Constructor for when the range of visible KVStore keys is all keys sharing a given byte[] prefix.

Parameters:

kv - underlying KVStore

prefix - prefix defining minimum and maximum keys

Throws:

NullPointerException - if prefix is null

KVNavigableMap

protected KVNavigableMap(KVStore kv,
 boolean reversed,
 KeyRange keyRange,
 KeyFilter keyFilter)

Primary constructor.

Parameters:

kv - underlying KVStore

reversed - whether ordering is reversed

keyRange - key range restriction, or null for none

keyFilter - key filter, or null for none

Throws:

IllegalArgumentException - if kv is null

Method Details

comparator

public Comparator<ByteData> comparator()

put

public ByteData put(ByteData key,
 ByteData value)

Specified by:

put in interface Map<ByteData,ByteData>

Overrides:

put in class AbstractMap<ByteData,ByteData>

remove

public ByteData remove(Object obj)

Description copied from class: AbstractNavigableMap

Removes the mapping for a key from this map if it is present.

The implementation in AbstractNavigableMap always throws UnsupportedOperationException.

Specified by:

remove in interface Map<ByteData,ByteData>

Overrides:

remove in class AbstractNavigableMap<ByteData,ByteData>

clear

public void clear()

Specified by:

clear in interface Map<ByteData,ByteData>

Overrides:

clear in class AbstractMap<ByteData,ByteData>

containsKey

public boolean containsKey(Object obj)

Specified by:

containsKey in interface Map<ByteData,ByteData>

Overrides:

containsKey in class AbstractNavigableMap<ByteData,ByteData>

encodeKey

protected void encodeKey(ByteData.Writer writer,
 Object obj)

Description copied from class: AbstractKVNavigableMap

Encode the given key object into a byte[] key. Note that this method must throw IllegalArgumentException, not ClassCastException or NullPointerException, if obj does not have the correct type or is an illegal null value.

Specified by:

encodeKey in class AbstractKVNavigableMap<ByteData,ByteData>

Parameters:

writer - output for encoded byte[] key corresponding to obj

obj - map key object

decodeKey

protected ByteData decodeKey(ByteData.Reader reader)

Description copied from class: AbstractKVNavigableMap

Decode a key object from an encoded byte[] key.

If not in prefix mode, all of reader must be consumed; otherwise, the consumed portion is the prefix and any following keys with the same prefix are ignored.

Specified by:

decodeKey in class AbstractKVNavigableMap<ByteData,ByteData>

Parameters:

reader - input for encoded bytes

Returns:

decoded map key

decodeValue

protected ByteData decodeValue(KVPair pair)

Description copied from class: AbstractKVNavigableMap

Decode a value object from an encoded byte[] key/value pair.

Specified by:

decodeValue in class AbstractKVNavigableMap<ByteData,ByteData>

Parameters:

pair - key/value pair

Returns:

decoded map value

createSubMap

protected NavigableMap<ByteData,ByteData> createSubMap(boolean newReversed,
 KeyRange newKeyRange,
 KeyFilter newKeyFilter,
 Bounds<ByteData> newBounds)

Description copied from class: AbstractKVNavigableMap

Create a (possibly reversed) view of this instance with (possibly) tighter lower and/or upper bounds and the given KeyFilter, if any. The bounds are consistent with the reversed ordering (i.e., reversed if reverse is true) and have already been range-checked against this instance's bounds.

Specified by:

createSubMap in class AbstractKVNavigableMap<ByteData,ByteData>

Parameters:

newReversed - whether the new map's ordering should be reversed (implies newBounds are also inverted, but not keyRange); note: means "absolutely" reversed, not relative to this instance

newKeyRange - new key range, or null for none; will be consistent with bounds, if any

newKeyFilter - new key filter, or null for none

newBounds - new bounds

Returns:

restricted and/or filtered view of this instance