Package org.apache.commons.collections4.trie

Class AbstractPatriciaTrie.PrefixRangeMap

java.lang.Object

java.util.AbstractMap<K,V>

org.apache.commons.collections4.trie.AbstractPatriciaTrie.RangeMap

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

All Implemented Interfaces:

java.util.Map<K,V>, java.util.SortedMap<K,V>

Enclosing class:

AbstractPatriciaTrie<K,V>

private class AbstractPatriciaTrie.PrefixRangeMap
extends AbstractPatriciaTrie.RangeMap

A submap used for prefix views over the Trie.

Nested Class Summary

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

java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,V extends java.lang.Object>

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

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
private int	expectedModCount
private K	fromKey
private int	lengthInBits
private int	offsetInBits
private 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.PrefixRangeMap.

Method Summary

Modifier and Type	Method	Description
void	clear()
protected java.util.Set<java.util.Map.Entry<K,V>>	createEntrySet()	Creates and returns an AbstractPatriciaTrie.RangeMap.entrySet() view of the AbstractPatriciaTrie.RangeMap.
protected java.util.SortedMap<K,V>	createRangeMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)	Creates and returns a sub-range view of the current AbstractPatriciaTrie.RangeMap.
K	firstKey()
private int	fixup()	This method does two things.
K	getFromKey()	Returns the FROM Key.
K	getToKey()	Returns the TO Key.
protected boolean	inFromRange(K key, boolean forceInclusive)	Returns true if the provided Key is in the FROM range of the AbstractPatriciaTrie.PrefixRangeMap.
protected boolean	inRange(K key)	Returns true if this AbstractPatriciaTrie.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.PrefixRangeMap.
boolean	isFromInclusive()	Whether or not the AbstractPatriciaTrie.RangeMap.getFromKey() is in the range.
boolean	isToInclusive()	Whether or not the AbstractPatriciaTrie.RangeMap.getToKey() is in the range.
K	lastKey()

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

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 Detail

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 Detail

PrefixRangeMap

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

Creates a AbstractPatriciaTrie.PrefixRangeMap.

Method Detail

fixup

private int fixup()

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

firstKey

public K firstKey()

lastKey

public K lastKey()

inRange

protected boolean inRange(K key)

Returns true if this AbstractPatriciaTrie.PrefixRangeMap's key is a prefix of the provided key.

Overrides:

inRange in class AbstractPatriciaTrie.RangeMap

inRange2

protected boolean inRange2(K key)

Same as inRange(Object).

Overrides:

inRange2 in class AbstractPatriciaTrie.RangeMap

inFromRange

protected boolean inFromRange(K key,
                              boolean forceInclusive)

Returns true if the provided Key is in the FROM range of the AbstractPatriciaTrie.PrefixRangeMap.

Overrides:

inFromRange in class AbstractPatriciaTrie.RangeMap

inToRange

protected boolean inToRange(K key,
                            boolean forceInclusive)

Returns true if the provided Key is in the TO range of the AbstractPatriciaTrie.PrefixRangeMap.

Overrides:

inToRange in class AbstractPatriciaTrie.RangeMap

createEntrySet

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

Description copied from class: AbstractPatriciaTrie.RangeMap

Creates and returns an AbstractPatriciaTrie.RangeMap.entrySet() view of the AbstractPatriciaTrie.RangeMap.

Specified by:

createEntrySet in class AbstractPatriciaTrie.RangeMap

getFromKey

public K getFromKey()

Description copied from class: AbstractPatriciaTrie.RangeMap

Returns the FROM Key.

Specified by:

getFromKey in class AbstractPatriciaTrie.RangeMap

getToKey

public K getToKey()

Description copied from class: AbstractPatriciaTrie.RangeMap

Returns the TO Key.

Specified by:

getToKey in class AbstractPatriciaTrie.RangeMap

isFromInclusive

public boolean isFromInclusive()

Description copied from class: AbstractPatriciaTrie.RangeMap

Whether or not the AbstractPatriciaTrie.RangeMap.getFromKey() is in the range.

Specified by:

isFromInclusive in class AbstractPatriciaTrie.RangeMap

isToInclusive

public boolean isToInclusive()

Description copied from class: AbstractPatriciaTrie.RangeMap

Whether or not the AbstractPatriciaTrie.RangeMap.getToKey() is in the range.

Specified by:

isToInclusive in class AbstractPatriciaTrie.RangeMap

createRangeMap

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

Description copied from class: AbstractPatriciaTrie.RangeMap

Creates and returns a sub-range view of the current AbstractPatriciaTrie.RangeMap.

Specified by:

createRangeMap in class AbstractPatriciaTrie.RangeMap

clear

public void clear()

Specified by:

clear in interface java.util.Map<K,V>

Overrides:

clear in class java.util.AbstractMap<K,V>