Class AbstractBitwiseTrie<K,V>
java.lang.Object
java.util.AbstractMap<K,V>
org.apache.commons.collections4.trie.AbstractBitwiseTrie<K,V>
- Type Parameters:
K
- the type of the keys in this mapV
- the type of the values in this map
- All Implemented Interfaces:
Serializable
,Map<K,
,V> SortedMap<K,
,V> Get<K,
,V> IterableGet<K,
,V> IterableMap<K,
,V> IterableSortedMap<K,
,V> OrderedMap<K,
,V> Put<K,
,V> Trie<K,
V>
- Direct Known Subclasses:
AbstractPatriciaTrie
public abstract class AbstractBitwiseTrie<K,V>
extends AbstractMap<K,V>
implements Trie<K,V>, Serializable
This class provides some basic
Trie
functionality and
utility methods for actual bitwise Trie
implementations.- Since:
- 4.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
A basic implementation ofMap.Entry
.Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,
V>, AbstractMap.SimpleImmutableEntry<K, V> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final KeyAnalyzer
<? super K> TheKeyAnalyzer
that's being used to build the PATRICIATrie
.private static final long
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AbstractBitwiseTrie
(KeyAnalyzer<? super K> keyAnalyzer) Constructs a newTrie
using the givenKeyAnalyzer
. -
Method Summary
Modifier and TypeMethodDescription(package private) final int
Utility method for callingKeyAnalyzer.bitIndex(Object, int, int, Object, int, int)
.(package private) final int
Returns the number of bits per element in the key(package private) final K
A utility method to cast keys.(package private) static boolean
Returns true if both values are either null or equal.(package private) final boolean
compareKeys
(K key, K other) An utility method for callingKeyAnalyzer.compare(Object, Object)
protected KeyAnalyzer
<? super K> Returns theKeyAnalyzer
that constructed theTrie
.(package private) final boolean
Returns whether or not the given bit on the key is set or false if the key is null.(package private) final int
lengthInBits
(K key) Returns the length of the given key in bitstoString()
Methods inherited from class java.util.AbstractMap
clear, clone, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.commons.collections4.Get
containsKey, containsValue, entrySet, get, isEmpty, keySet, remove, size, 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
Methods inherited from interface org.apache.commons.collections4.OrderedMap
firstKey, lastKey, mapIterator, nextKey, previousKey
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
keyAnalyzer
TheKeyAnalyzer
that's being used to build the PATRICIATrie
.
-
-
Constructor Details
-
AbstractBitwiseTrie
Constructs a newTrie
using the givenKeyAnalyzer
.- Parameters:
keyAnalyzer
- theKeyAnalyzer
to use
-
-
Method Details
-
getKeyAnalyzer
Returns theKeyAnalyzer
that constructed theTrie
.- Returns:
- the
KeyAnalyzer
used by thisTrie
-
toString
- Overrides:
toString
in classAbstractMap<K,
V>
-
castKey
A utility method to cast keys. It actually doesn't cast anything. It's just fooling the compiler! -
lengthInBits
Returns the length of the given key in bits- See Also:
-
bitsPerElement
final int bitsPerElement()Returns the number of bits per element in the key- See Also:
-
isBitSet
Returns whether or not the given bit on the key is set or false if the key is null.- See Also:
-
bitIndex
Utility method for callingKeyAnalyzer.bitIndex(Object, int, int, Object, int, int)
. -
compareKeys
An utility method for callingKeyAnalyzer.compare(Object, Object)
-
compare
Returns true if both values are either null or equal.
-