org.helenus.driver.impl

Class PersistedNavigableMap<K,T,PT>

java.lang.Object

java.util.AbstractMap<K,T>

org.helenus.driver.impl.PersistedMap<K,T,PT>

org.helenus.driver.impl.PersistedSortedMap<K,T,PT>

org.helenus.driver.impl.PersistedNavigableMap<K,T,PT>

Type Parameters:

K - the type of the keys

T - the decoded type of the values

PT - the persisted type from which we are decoding and to which we are encoding each values

All Implemented Interfaces:

Map<K,T>, NavigableMap<K,T>, SortedMap<K,T>, PersistedObject<T,PT>

public class PersistedNavigableMap<K,T,PT>
extends PersistedSortedMap<K,T,PT>
implements NavigableMap<K,T>, PersistedObject<T,PT>

The PersistedNavigableMap class provides a NavigableMap implementation suitable to hold persisted values.

Since:

1.0

Version:

1 - Nov 10, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2015 The Helenus Driver Project Authors

Nested Class Summary

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>

Method Summary

Modifier and Type	Method and Description
Map.Entry<K,T>	ceilingEntry(K key)
K	ceilingKey(K key)
NavigableSet<K>	descendingKeySet()
NavigableMap<K,T>	descendingMap()
Map.Entry<K,T>	firstEntry()
Map.Entry<K,T>	floorEntry(K key)
K	floorKey(K key)
NavigableMap<K,PersistedValue<T,PT>>	getPersistedMap() Gets the persisted map.
NavigableMap<K,T>	headMap(K toKey, boolean inclusive)
Map.Entry<K,T>	higherEntry(K key)
K	higherKey(K key)
Map.Entry<K,T>	lastEntry()
Map.Entry<K,T>	lowerEntry(K key)
K	lowerKey(K key)
NavigableSet<K>	navigableKeySet()
Map.Entry<K,T>	pollFirstEntry()
Map.Entry<K,T>	pollLastEntry()
NavigableMap<K,T>	subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
NavigableMap<K,T>	tailMap(K fromKey, boolean inclusive)

Methods inherited from class org.helenus.driver.impl.PersistedSortedMap

comparator, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from class org.helenus.driver.impl.PersistedMap

clear, containsKey, entrySet, get, isEmpty, keySet, put, remove, size, toString, values

Methods inherited from class java.util.AbstractMap

clone, containsValue, equals, hashCode, putAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.NavigableMap

headMap, subMap, tailMap

Methods inherited from interface java.util.SortedMap

comparator, entrySet, firstKey, keySet, lastKey, values

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

Method Detail

getPersistedMap

public NavigableMap<K,PersistedValue<T,PT>> getPersistedMap()

Gets the persisted map.

Overrides:

getPersistedMap in class PersistedSortedMap<K,T,PT>

Returns:

the non-null persisted map

See Also:

PersistedMap.getPersistedMap()

lowerEntry

public Map.Entry<K,T> lowerEntry(K key)

Specified by:

lowerEntry in interface NavigableMap<K,T>

See Also:

NavigableMap.lowerEntry(java.lang.Object)

lowerKey

public K lowerKey(K key)

Specified by:

lowerKey in interface NavigableMap<K,T>

See Also:

NavigableMap.lowerKey(java.lang.Object)

floorEntry

public Map.Entry<K,T> floorEntry(K key)

Specified by:

floorEntry in interface NavigableMap<K,T>

See Also:

NavigableMap.floorEntry(java.lang.Object)

floorKey

public K floorKey(K key)

Specified by:

floorKey in interface NavigableMap<K,T>

See Also:

NavigableMap.floorKey(java.lang.Object)

ceilingEntry

public Map.Entry<K,T> ceilingEntry(K key)

Specified by:

ceilingEntry in interface NavigableMap<K,T>

See Also:

NavigableMap.ceilingEntry(java.lang.Object)

ceilingKey

public K ceilingKey(K key)

Specified by:

ceilingKey in interface NavigableMap<K,T>

See Also:

NavigableMap.ceilingKey(java.lang.Object)

higherEntry

public Map.Entry<K,T> higherEntry(K key)

Specified by:

higherEntry in interface NavigableMap<K,T>

See Also:

NavigableMap.higherEntry(java.lang.Object)

higherKey

public K higherKey(K key)

Specified by:

higherKey in interface NavigableMap<K,T>

See Also:

NavigableMap.higherKey(java.lang.Object)

firstEntry

public Map.Entry<K,T> firstEntry()

Specified by:

firstEntry in interface NavigableMap<K,T>

See Also:

NavigableMap.firstEntry()

lastEntry

public Map.Entry<K,T> lastEntry()

Specified by:

lastEntry in interface NavigableMap<K,T>

See Also:

NavigableMap.lastEntry()

pollFirstEntry

public Map.Entry<K,T> pollFirstEntry()

Specified by:

pollFirstEntry in interface NavigableMap<K,T>

See Also:

NavigableMap.pollFirstEntry()

pollLastEntry

public Map.Entry<K,T> pollLastEntry()

Specified by:

pollLastEntry in interface NavigableMap<K,T>

See Also:

NavigableMap.pollLastEntry()

descendingMap

public NavigableMap<K,T> descendingMap()

Specified by:

descendingMap in interface NavigableMap<K,T>

See Also:

NavigableMap.descendingMap()

navigableKeySet

public NavigableSet<K> navigableKeySet()

Specified by:

navigableKeySet in interface NavigableMap<K,T>

See Also:

NavigableMap.navigableKeySet()

descendingKeySet

public NavigableSet<K> descendingKeySet()

Specified by:

descendingKeySet in interface NavigableMap<K,T>

See Also:

NavigableMap.descendingKeySet()

subMap

public NavigableMap<K,T> subMap(K fromKey,
                                boolean fromInclusive,
                                K toKey,
                                boolean toInclusive)

Specified by:

subMap in interface NavigableMap<K,T>

See Also:

NavigableMap.subMap(java.lang.Object, boolean, java.lang.Object, boolean)

headMap

public NavigableMap<K,T> headMap(K toKey,
                                 boolean inclusive)

Specified by:

headMap in interface NavigableMap<K,T>

See Also:

NavigableMap.headMap(java.lang.Object, boolean)

tailMap

public NavigableMap<K,T> tailMap(K fromKey,
                                 boolean inclusive)

Specified by:

tailMap in interface NavigableMap<K,T>

See Also:

NavigableMap.tailMap(java.lang.Object, boolean)