Package io.permazen.util

Class ConvertedNavigableMap<K,V,WK,WV>

java.lang.Object

java.util.AbstractMap<K,V>

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

io.permazen.util.ConvertedNavigableMap<K,V,WK,WV>

Type Parameters:

K - key type of this map

V - value type of this map

WK - key type of wrapped map

WV - value type of wrapped map

All Implemented Interfaces:

Map<K,V>, NavigableMap<K,V>, SortedMap<K,V>

public class ConvertedNavigableMap<K,V,WK,WV>
extends AbstractNavigableMap<K,V>

Provides a transformed view of a wrapped NavigableMap using a strictly invertible Converter.

Supplied Converters may throw ClassCastException or IllegalArgumentException if given an objects whose runtime type does not match the expected type.

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.util.AbstractNavigableMap

bounds

Constructor Summary

Constructors

Constructor	Description
ConvertedNavigableMap(NavigableMap<WK,WV> map, Converter<K,WK> keyConverter, Converter<V,WV> valueConverter)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()
Comparator<? super K>	comparator()
protected NavigableMap<K,V>	createSubMap(boolean reverse, Bounds<K> newBounds)	Create a (possibly reversed) view of this instance with (possibly) tighter lower and/or upper bounds.
Set<Map.Entry<K,V>>	entrySet()
V	get(Object key)
Converter<K,WK>	getKeyConverter()
Converter<V,WV>	getValueConverter()
boolean	isEmpty()
NavigableSet<K>	navigableKeySet()
V	put(K key, V value)
V	remove(Object key)	Removes the mapping for a key from this map if it is present.
protected Map.Entry<K,V>	searchAbove(K minKey, boolean inclusive)	Search for a higher element.
protected Map.Entry<K,V>	searchBelow(K maxKey, boolean inclusive)	Search for a lower element.
int	size()

Methods inherited from class io.permazen.util.AbstractNavigableMap

ceilingEntry, ceilingKey, containsKey, descendingKeySet, descendingMap, firstEntry, firstKey, floorEntry, floorKey, getBounds, getComparator, headMap, headMap, higherEntry, higherKey, isWithinLowerBound, isWithinUpperBound, keySet, lastEntry, lastKey, lowerEntry, lowerKey, pollFirstEntry, pollLastEntry, subMap, subMap, tailMap, tailMap

Methods inherited from class java.util.AbstractMap

clone, containsValue, equals, hashCode, putAll, 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

Methods inherited from interface java.util.SortedMap

values

Constructor Details

ConvertedNavigableMap

public ConvertedNavigableMap(NavigableMap<WK,WV> map,
 Converter<K,WK> keyConverter,
 Converter<V,WV> valueConverter)

Constructor.

Parameters:

map - wrapped map

keyConverter - key converter

valueConverter - value converter

Throws:

IllegalArgumentException - if any parameter is null

Method Details

getKeyConverter

public Converter<K,WK> getKeyConverter()

getValueConverter

public Converter<V,WV> getValueConverter()

comparator

public Comparator<? super K> comparator()

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

Overrides:

get 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>

navigableKeySet

public NavigableSet<K> navigableKeySet()

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)

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<K,V>

Overrides:

remove in class AbstractNavigableMap<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractMap<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

Overrides:

isEmpty in class AbstractNavigableMap<K,V>

size

public int size()

Specified by:

size in interface Map<K,V>

Overrides:

size in class AbstractMap<K,V>

searchBelow

protected Map.Entry<K,V> searchBelow(K maxKey,
 boolean inclusive)

Description copied from class: AbstractNavigableMap

Search for a lower element. Used to implement floorEntry() and lowerEntry().

The implementation in AbstractNavigableMap checks the bounds then returns the first entry from a head map.

Overrides:

searchBelow in class AbstractNavigableMap<K,V>

Parameters:

maxKey - upper limit for search

inclusive - true if maxKey itself is a candidate

Returns:

highest element below maxKey, or null if not found

searchAbove

protected Map.Entry<K,V> searchAbove(K minKey,
 boolean inclusive)

Description copied from class: AbstractNavigableMap

Search for a higher element. Used to implement ceilingEntry() and higherEntry().

The implementation in AbstractNavigableMap checks the bounds then returns the first entry from a tail map.

Overrides:

searchAbove in class AbstractNavigableMap<K,V>

Parameters:

minKey - lower limit for search

inclusive - true if minKey itself is a candidate

Returns:

lowest element above minKey, or null if not found

createSubMap

protected NavigableMap<K,V> createSubMap(boolean reverse,
 Bounds<K> newBounds)

Description copied from class: AbstractNavigableMap

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

Specified by:

createSubMap in class AbstractNavigableMap<K,V>

Parameters:

reverse - whether the new map's ordering should be reversed relative to this instance's ordering

newBounds - new bounds

Returns:

restricted and/or reversed view of this instance