com.goldencode.util

Class CaseInsensitiveHashMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

org.apache.commons.collections4.map.AbstractHashedMap<K,V>

com.goldencode.util.CaseInsensitiveHashMap<K,V>

Type Parameters:

K - Type of the keys

V - Type of the values

All Implemented Interfaces:

java.util.Map<K,V>, org.apache.commons.collections4.Get<K,V>, org.apache.commons.collections4.IterableGet<K,V>, org.apache.commons.collections4.IterableMap<K,V>, org.apache.commons.collections4.Put<K,V>

public class CaseInsensitiveHashMap<K,V>
extends org.apache.commons.collections4.map.AbstractHashedMap<K,V>

Case-insensitive hash map with API compatible with Java hash map.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.collections4.map.AbstractHashedMap

org.apache.commons.collections4.map.AbstractHashedMap.EntrySet<K,V>, org.apache.commons.collections4.map.AbstractHashedMap.EntrySetIterator<K,V>, org.apache.commons.collections4.map.AbstractHashedMap.HashEntry<K,V>, org.apache.commons.collections4.map.AbstractHashedMap.HashIterator<K,V>, org.apache.commons.collections4.map.AbstractHashedMap.HashMapIterator<K,V>, org.apache.commons.collections4.map.AbstractHashedMap.KeySet<K>, org.apache.commons.collections4.map.AbstractHashedMap.KeySetIterator<K>, org.apache.commons.collections4.map.AbstractHashedMap.Values<V>, org.apache.commons.collections4.map.AbstractHashedMap.ValuesIterator<V>

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

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

Field Summary

Fields

Modifier and Type	Field and Description
private static int	NULL_HASH Represents the null value
private boolean	rtrim Flag to indicate if the comparisons should be done ignoring right spaces.

Fields inherited from class org.apache.commons.collections4.map.AbstractHashedMap

DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR, DEFAULT_THRESHOLD, GETKEY_INVALID, GETVALUE_INVALID, MAXIMUM_CAPACITY, NO_NEXT_ENTRY, NO_PREVIOUS_ENTRY, NULL, REMOVE_INVALID, SETVALUE_INVALID

Constructor Summary

Constructors

Constructor and Description
CaseInsensitiveHashMap() Default constructor.
CaseInsensitiveHashMap(boolean rtrim) Default constructor.
CaseInsensitiveHashMap(int initialCapacity) Create the map with the supplied initial capacity and load factor of 0.75.
CaseInsensitiveHashMap(int initialCapacity, float loadFactor) Create the map with the supplied initial capacity and load factor.
CaseInsensitiveHashMap(int initialCapacity, float loadFactor, int threshold) Create the map with the supplied initial capacity, load factor and threshold.

Method Summary

Modifier and Type	Method and Description
protected int	hash(java.lang.Object key) Hash the supplied key.
protected boolean	isEqualKey(java.lang.Object key1, java.lang.Object key2) Compare two keys.
static void	main(java.lang.String[] args) Profiling test comparing the native hash-map which needs lower-case and this implementation which does the case-insensitive look-up implicitly.

Methods inherited from class org.apache.commons.collections4.map.AbstractHashedMap

addEntry, addMapping, calculateNewCapacity, calculateThreshold, checkCapacity, clear, clone, containsKey, containsValue, convertKey, createEntry, createEntrySetIterator, createKeySetIterator, createValuesIterator, destroyEntry, doReadObject, doWriteObject, ensureCapacity, entryHashCode, entryKey, entryNext, entrySet, entryValue, equals, get, getEntry, hashCode, hashIndex, init, isEmpty, isEqualValue, keySet, mapIterator, put, putAll, remove, removeEntry, removeMapping, reuseEntry, size, toString, updateEntry, 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, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

NULL_HASH

private static final int NULL_HASH

Represents the null value

rtrim

private boolean rtrim

Flag to indicate if the comparisons should be done ignoring right spaces.

Constructor Detail

CaseInsensitiveHashMap

public CaseInsensitiveHashMap()

Default constructor. Initializes the map with initial capacity of 16 and load factor of 0.75.

CaseInsensitiveHashMap

public CaseInsensitiveHashMap(boolean rtrim)

Default constructor. Initializes the map with initial capacity of 16 and load factor of 0.75.

Parameters:

rtrim - true only if the comparisons should be done without trailing spaces. The rtrim will be automatically applied to the stored keys and the look-up keys.

CaseInsensitiveHashMap

public CaseInsensitiveHashMap(int initialCapacity,
                              float loadFactor,
                              int threshold)

Create the map with the supplied initial capacity, load factor and threshold.

Parameters:

initialCapacity - Initial capacity of the map.

loadFactor - Load factor value.

threshold - Threshold value/

CaseInsensitiveHashMap

public CaseInsensitiveHashMap(int initialCapacity)

Create the map with the supplied initial capacity and load factor of 0.75.

Parameters:

initialCapacity - Initial capacity of the map.

CaseInsensitiveHashMap

public CaseInsensitiveHashMap(int initialCapacity,
                              float loadFactor)

Create the map with the supplied initial capacity and load factor.

Parameters:

initialCapacity - Initial capacity of the map.

loadFactor - Load factor value.

Method Detail

hash

protected int hash(java.lang.Object key)

Hash the supplied key.

Overrides:

hash in class org.apache.commons.collections4.map.AbstractHashedMap<K,V>

Parameters:

key - The key to hash.

Returns:

The calculated hash value.

isEqualKey

protected boolean isEqualKey(java.lang.Object key1,
                             java.lang.Object key2)

Compare two keys.

Overrides:

isEqualKey in class org.apache.commons.collections4.map.AbstractHashedMap<K,V>

Parameters:

key1 - The first key.

key2 - The second key.

Returns:

true if the keys equal, false otherwise.

main

public static void main(java.lang.String[] args)

Profiling test comparing the native hash-map which needs lower-case and this implementation which does the case-insensitive look-up implicitly.

Parameters:

args - Not required.