Package org.apache.commons.collections4.trie

Class AbstractPatriciaTrie.RangeEntryMap

java.lang.Object

java.util.AbstractMap<K,V>

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

org.apache.commons.collections4.trie.AbstractPatriciaTrie.RangeEntryMap

All Implemented Interfaces:

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

Enclosing class:

AbstractPatriciaTrie<K,V>

private class AbstractPatriciaTrie.RangeEntryMap
extends AbstractPatriciaTrie.RangeMap

A AbstractPatriciaTrie.RangeMap that deals with Map.Entrys.

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 boolean	fromInclusive	Whether or not the 'from' is inclusive.
private K	fromKey	The key to start from, null if the beginning.
private boolean	toInclusive	Whether or not the 'to' is inclusive.
private K	toKey	The key to end at, null if till the end.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RangeEntryMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)	Creates a AbstractPatriciaTrie.RangeEntryMap.
protected	RangeEntryMap(K fromKey, K toKey)	Creates a AbstractPatriciaTrie.RangeEntryMap with the fromKey included and the toKey excluded from the range.

Method Summary

Modifier and Type	Method	Description
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()
K	getFromKey()	Returns the FROM Key.
K	getToKey()	Returns the TO Key.
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, inFromRange, inRange, inRange2, inToRange, put, remove, subMap, tailMap

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

keySet, values

Field Detail

fromKey

private final K fromKey

The key to start from, null if the beginning.

toKey

private final K toKey

The key to end at, null if till the end.

fromInclusive

private final boolean fromInclusive

Whether or not the 'from' is inclusive.

toInclusive

private final boolean toInclusive

Whether or not the 'to' is inclusive.

Constructor Detail

RangeEntryMap

protected RangeEntryMap(K fromKey,
                        K toKey)

Creates a AbstractPatriciaTrie.RangeEntryMap with the fromKey included and the toKey excluded from the range.

RangeEntryMap

protected RangeEntryMap(K fromKey,
                        boolean fromInclusive,
                        K toKey,
                        boolean toInclusive)

Creates a AbstractPatriciaTrie.RangeEntryMap.

Method Detail

firstKey

public K firstKey()

lastKey

public K lastKey()

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