Package org.apache.commons.collections4.trie

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 map

V - 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:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	AbstractBitwiseTrie.BasicEntry<K,V>	A basic implementation of Map.Entry.

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 final KeyAnalyzer<? super K>	keyAnalyzer	The KeyAnalyzer that's being used to build the PATRICIA Trie.
private static final long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBitwiseTrie(KeyAnalyzer<? super K> keyAnalyzer)	Constructs a new Trie using the given KeyAnalyzer.

Method Summary

Modifier and Type	Method	Description
(package private) final int	bitIndex(K key, K foundKey)	Utility method for calling KeyAnalyzer.bitIndex(Object, int, int, Object, int, int).
(package private) final int	bitsPerElement()	Returns the number of bits per element in the key
(package private) final K	castKey(Object key)	A utility method to cast keys.
(package private) static boolean	compare(Object a, Object b)	Delegates to Objects.equals(Object, Object).
(package private) final boolean	compareKeys(K key, K other)	A utility method for calling KeyAnalyzer.compare(Object, Object)
protected KeyAnalyzer<? super K>	getKeyAnalyzer()	Gets the KeyAnalyzer that constructed the Trie.
(package private) final boolean	isBitSet(K key, int bitIndex, int lengthInBits)	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 bits
String	toString()

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

Methods inherited from interface org.apache.commons.collections4.Put

clear, put, putAll

Methods inherited from interface java.util.SortedMap

comparator, entrySet, firstKey, headMap, keySet, lastKey, subMap, tailMap, values

Methods inherited from interface org.apache.commons.collections4.Trie

prefixMap

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

keyAnalyzer

private final KeyAnalyzer<? super K> keyAnalyzer

The KeyAnalyzer that's being used to build the PATRICIA Trie.

Constructor Details

AbstractBitwiseTrie

protected AbstractBitwiseTrie(KeyAnalyzer<? super K> keyAnalyzer)

Constructs a new Trie using the given KeyAnalyzer.

Parameters:

keyAnalyzer - the KeyAnalyzer to use

Method Details

compare

static boolean compare(Object a,
 Object b)

Delegates to Objects.equals(Object, Object).

bitIndex

final int bitIndex(K key,
 K foundKey)

Utility method for calling KeyAnalyzer.bitIndex(Object, int, int, Object, int, int).

bitsPerElement

final int bitsPerElement()

Returns the number of bits per element in the key

See Also:

• KeyAnalyzer.bitsPerElement()

castKey

final K castKey(Object key)

A utility method to cast keys. It actually doesn't cast anything. It's just fooling the compiler!

compareKeys

final boolean compareKeys(K key,
 K other)

A utility method for calling KeyAnalyzer.compare(Object, Object)

getKeyAnalyzer

protected KeyAnalyzer<? super K> getKeyAnalyzer()

Gets the KeyAnalyzer that constructed the Trie.

Returns:

the KeyAnalyzer used by this Trie

isBitSet

final boolean isBitSet(K key,
 int bitIndex,
 int lengthInBits)

Returns whether or not the given bit on the key is set or false if the key is null.

See Also:

• KeyAnalyzer.isBitSet(Object, int, int)

lengthInBits

final int lengthInBits(K key)

Returns the length of the given key in bits

See Also:

• KeyAnalyzer.lengthInBits(Object)

toString

public String toString()

Overrides:

toString in class AbstractMap<K,V>