Package org.apache.commons.collections4.trie

Class AbstractPatriciaTrie.AbstractRangeMap

java.lang.Object

java.util.AbstractMap<K,V>

org.apache.commons.collections4.trie.AbstractPatriciaTrie.AbstractRangeMap

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractPatriciaTrie.PrefixRangeMap, AbstractPatriciaTrie.RangeEntryMap

Enclosing class:

AbstractPatriciaTrie<K,V>

private abstract class AbstractPatriciaTrie.AbstractRangeMap
extends AbstractMap<K,V>
implements SortedMap<K,V>

A range view of the Trie.

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>

Field Summary

Fields

Modifier and Type	Field	Description
private Set<Map.Entry<K,V>>	entrySet	The entrySet() view.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AbstractRangeMap()

Method Summary

Modifier and Type	Method	Description
Comparator<? super K>	comparator()
boolean	containsKey(Object key)
protected abstract Set<Map.Entry<K,V>>	createEntrySet()	Creates and returns an entrySet() view of the AbstractPatriciaTrie<K,V>.AbstractRangeMap.
protected abstract SortedMap<K,V>	createRangeMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)	Creates and returns a sub-range view of the current AbstractPatriciaTrie<K,V>.AbstractRangeMap.
Set<Map.Entry<K,V>>	entrySet()
V	get(Object key)
protected abstract K	getFromKey()	Gets the FROM Key.
protected abstract K	getToKey()	Gets the TO Key.
SortedMap<K,V>	headMap(K toKey)
protected boolean	inFromRange(K key, boolean forceInclusive)	Returns true if the provided key is in the FROM range of the AbstractPatriciaTrie<K,V>.AbstractRangeMap.
protected boolean	inRange(K key)	Returns true if the provided key is greater than TO and less than FROM.
protected boolean	inRange2(K key)	This form allows the high endpoint (as well as all legit keys).
protected boolean	inToRange(K key, boolean forceInclusive)	Returns true if the provided key is in the TO range of the AbstractPatriciaTrie<K,V>.AbstractRangeMap.
protected abstract boolean	isFromInclusive()	Tests whether or not the getFromKey() is in the range.
protected abstract boolean	isToInclusive()	Tests whether or not the getToKey() is in the range.
V	put(K key, V value)
V	remove(Object key)
SortedMap<K,V>	subMap(K fromKey, K toKey)
SortedMap<K,V>	tailMap(K fromKey)

Methods inherited from class java.util.AbstractMap

clear, clone, containsValue, equals, hashCode, isEmpty, keySet, 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

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

Methods inherited from interface java.util.SortedMap

firstKey, keySet, lastKey, values

Field Details

entrySet

private transient volatile Set<Map.Entry<K,V>> entrySet

The entrySet() view.

Constructor Details

AbstractRangeMap

private AbstractRangeMap()

Method Details

comparator

public Comparator<? super K> comparator()

Specified by:

comparator in interface SortedMap<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

Overrides:

containsKey in class AbstractMap<K,V>

createEntrySet

protected abstract Set<Map.Entry<K,V>> createEntrySet()

Creates and returns an entrySet() view of the AbstractPatriciaTrie<K,V>.AbstractRangeMap.

createRangeMap

protected abstract SortedMap<K,V> createRangeMap(K fromKey,
 boolean fromInclusive,
 K toKey,
 boolean toInclusive)

Creates and returns a sub-range view of the current AbstractPatriciaTrie<K,V>.AbstractRangeMap.

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>

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

Overrides:

get in class AbstractMap<K,V>

getFromKey

protected abstract K getFromKey()

Gets the FROM Key.

getToKey

protected abstract K getToKey()

Gets the TO Key.

headMap

public SortedMap<K,V> headMap(K toKey)

Specified by:

headMap in interface SortedMap<K,V>

inFromRange

protected boolean inFromRange(K key,
 boolean forceInclusive)

Returns true if the provided key is in the FROM range of the AbstractPatriciaTrie<K,V>.AbstractRangeMap.

inRange

protected boolean inRange(K key)

Returns true if the provided key is greater than TO and less than FROM.

inRange2

protected boolean inRange2(K key)

This form allows the high endpoint (as well as all legit keys).

inToRange

protected boolean inToRange(K key,
 boolean forceInclusive)

Returns true if the provided key is in the TO range of the AbstractPatriciaTrie<K,V>.AbstractRangeMap.

isFromInclusive

protected abstract boolean isFromInclusive()

Tests whether or not the getFromKey() is in the range.

Returns:

whether or not the getFromKey() is in the range.

isToInclusive

protected abstract boolean isToInclusive()

Tests whether or not the getToKey() is in the range.

Returns:

whether or not the getToKey() is in the range.

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>

subMap

public SortedMap<K,V> subMap(K fromKey,
 K toKey)

Specified by:

subMap in interface SortedMap<K,V>

tailMap

public SortedMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface SortedMap<K,V>