Package org.apache.commons.collections4.trie

Class AbstractPatriciaTrie.PrefixRangeMap

java.lang.Object

java.util.AbstractMap<K,V>

AbstractPatriciaTrie<K,V>.org.apache.commons.collections4.trie.AbstractPatriciaTrie.AbstractRangeMap

org.apache.commons.collections4.trie.AbstractPatriciaTrie.PrefixRangeMap

All Implemented Interfaces:

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

Enclosing class:

AbstractPatriciaTrie<K,V>

private final class AbstractPatriciaTrie.PrefixRangeMap
extends AbstractPatriciaTrie<K,V>.AbstractRangeMap

A submap used for prefix views over 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 int	expectedModCount
private K	fromKey
private final int	lengthInBits
private final int	offsetInBits
private final K	prefix
private int	size
private K	toKey

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PrefixRangeMap(K prefix, int offsetInBits, int lengthInBits)	Creates a AbstractPatriciaTrie<K,V>.PrefixRangeMap.

Method Summary

Modifier and Type	Method	Description
void	clear()
protected Set<Map.Entry<K,V>>	createEntrySet()	Creates and returns an AbstractPatriciaTrie.AbstractRangeMap.entrySet() view of the AbstractPatriciaTrie<K,V>.AbstractRangeMap.
protected 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.
K	firstKey()
private int	fixup()	This method does two things.
K	getFromKey()	Gets the FROM Key.
K	getToKey()	Gets the TO Key.
protected boolean	inFromRange(K key, boolean forceInclusive)	Returns true if the provided Key is in the FROM range of the AbstractPatriciaTrie<K,V>.PrefixRangeMap.
protected boolean	inRange(K key)	Returns true if this AbstractPatriciaTrie<K,V>.PrefixRangeMap's key is a prefix of the provided key.
protected boolean	inRange2(K key)	Same as inRange(Object).
protected boolean	inToRange(K key, boolean forceInclusive)	Returns true if the provided Key is in the TO range of the AbstractPatriciaTrie<K,V>.PrefixRangeMap.
boolean	isFromInclusive()	Tests whether or not the AbstractPatriciaTrie.AbstractRangeMap.getFromKey() is in the range.
boolean	isToInclusive()	Tests whether or not the AbstractPatriciaTrie.AbstractRangeMap.getToKey() is in the range.
K	lastKey()

Methods inherited from class org.apache.commons.collections4.trie.AbstractPatriciaTrie.AbstractRangeMap

comparator, containsKey, entrySet, get, headMap, put, remove, subMap, tailMap

Methods inherited from class java.util.AbstractMap

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

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

Methods inherited from interface java.util.SortedMap

keySet, values

Field Details

prefix

private final K prefix

offsetInBits

private final int offsetInBits

lengthInBits

private final int lengthInBits

fromKey

private K fromKey

toKey

private K toKey

expectedModCount

private transient int expectedModCount

size

private int size

Constructor Details

PrefixRangeMap

private PrefixRangeMap(K prefix,
 int offsetInBits,
 int lengthInBits)

Creates a AbstractPatriciaTrie<K,V>.PrefixRangeMap.

Method Details

clear

public void clear()

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractMap<K,V>

createEntrySet

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

Description copied from class: AbstractPatriciaTrie.AbstractRangeMap

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

Specified by:

createEntrySet in class AbstractPatriciaTrie<K,V>.AbstractRangeMap

createRangeMap

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

Description copied from class: AbstractPatriciaTrie.AbstractRangeMap

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

Specified by:

createRangeMap in class AbstractPatriciaTrie<K,V>.AbstractRangeMap

firstKey

public K firstKey()

fixup

private int fixup()

This method does two things. It determines the FROM and TO range of the AbstractPatriciaTrie<K,V>.PrefixRangeMap and the number of elements in the range. This method must be called every time the Trie has changed.

getFromKey

public K getFromKey()

Description copied from class: AbstractPatriciaTrie.AbstractRangeMap

Gets the FROM Key.

Specified by:

getFromKey in class AbstractPatriciaTrie<K,V>.AbstractRangeMap

getToKey

public K getToKey()

Description copied from class: AbstractPatriciaTrie.AbstractRangeMap

Gets the TO Key.

Specified by:

getToKey in class AbstractPatriciaTrie<K,V>.AbstractRangeMap

inFromRange

protected boolean inFromRange(K key,
 boolean forceInclusive)

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

Overrides:

inFromRange in class AbstractPatriciaTrie<K,V>.AbstractRangeMap

inRange

protected boolean inRange(K key)

Returns true if this AbstractPatriciaTrie<K,V>.PrefixRangeMap's key is a prefix of the provided key.

Overrides:

inRange in class AbstractPatriciaTrie<K,V>.AbstractRangeMap

inRange2

protected boolean inRange2(K key)

Same as inRange(Object).

Overrides:

inRange2 in class AbstractPatriciaTrie<K,V>.AbstractRangeMap

inToRange

protected boolean inToRange(K key,
 boolean forceInclusive)

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

Overrides:

inToRange in class AbstractPatriciaTrie<K,V>.AbstractRangeMap

isFromInclusive

public boolean isFromInclusive()

Description copied from class: AbstractPatriciaTrie.AbstractRangeMap

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

Specified by:

isFromInclusive in class AbstractPatriciaTrie<K,V>.AbstractRangeMap

Returns:

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

isToInclusive

public boolean isToInclusive()

Description copied from class: AbstractPatriciaTrie.AbstractRangeMap

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

Specified by:

isToInclusive in class AbstractPatriciaTrie<K,V>.AbstractRangeMap

Returns:

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

lastKey

public K lastKey()