Package com.saperion.common.lang.collection

Class CaseInsensitiveMap<T>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,T>

com.saperion.common.lang.collection.CaseInsensitiveMap<T>

Type Parameters:

T - the type of mapped values

All Implemented Interfaces:

Serializable, Cloneable, Map<String,T>

public class CaseInsensitiveMap<T>
extends HashMap<String,T>

A CaseInsensitiveMap is a specialized HashMap with case insensitive keys of type String.

All keys will be converted with String.toLowerCase(Locale) with Locale.ENGLISH.

The keys are stored internally in lower case and all requests convert the specified key first and than compare it with the stored key as usual with Object.equals(Object).

This implementation is not synchronized. If used by different threads concurrently, external synchronization is necessary.

Author:

chm, agz

See Also:

• Serialized Form

Nested Class Summary

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

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

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

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
CaseInsensitiveMap()	Constructs an empty CaseInsensitiveMap with the default initial capacity (16) and the default load factor (0.75).
CaseInsensitiveMap(int initialCapacity)	Constructs an empty CaseInsensitiveMap with the specified initial capacity and the default load factor (0.75).
CaseInsensitiveMap(int initialCapacity, float loadFactor)	Constructs an empty CaseInsensitiveMap with the specified initial capacity and load factor.
CaseInsensitiveMap(Map<? extends String,? extends T> map)	Constructs a new CaseInsensitiveMap with the same mappings as the specified Map.

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(Object key)
T	get(Object key)
T	getOrDefault(Object key, T defaultValue)
T	put(String key, T value)
void	putAll(Map<? extends String,? extends T> m)
T	remove(Object key)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsValue, entrySet, forEach, isEmpty, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Details

CaseInsensitiveMap

public CaseInsensitiveMap()

Constructs an empty CaseInsensitiveMap with the default initial capacity (16) and the default load factor (0.75).

CaseInsensitiveMap

public CaseInsensitiveMap(int initialCapacity,
 float loadFactor)

Constructs an empty CaseInsensitiveMap with the specified initial capacity and load factor.

Parameters:

initialCapacity - the initial capacity

loadFactor - the load factor

Throws:

IllegalArgumentException - if the initial capacity is negative or the load factor is non-positive

CaseInsensitiveMap

public CaseInsensitiveMap(int initialCapacity)

Constructs an empty CaseInsensitiveMap with the specified initial capacity and the default load factor (0.75).

Parameters:

initialCapacity - the initial capacity.

Throws:

IllegalArgumentException - if the initial capacity is negative.

CaseInsensitiveMap

public CaseInsensitiveMap(Map<? extends String,? extends T> map)

Constructs a new CaseInsensitiveMap with the same mappings as the specified Map. The CaseInsensitiveMap is created with default load factor (0.75) and an initial capacity sufficient to hold the mappings in the specified Map.

Parameters:

map - the Map whose mappings are to be placed in this map

Throws:

NullPointerException - if the specified map is null

Method Details

containsKey

public boolean containsKey(Object key)

The key is interpreted case-insensitive.

Specified by:

containsKey in interface Map<String,T>

Overrides:

containsKey in class HashMap<String,T>

get

public T get(Object key)

The key is interpreted case-insensitive.

Specified by:

get in interface Map<String,T>

Overrides:

get in class HashMap<String,T>

put

public T put(String key,
 T value)

The key is converted to lower case before the mapping is stored.

Specified by:

put in interface Map<String,T>

Overrides:

put in class HashMap<String,T>

remove

public T remove(Object key)

The key is interpreted case-insensitive.

Specified by:

remove in interface Map<String,T>

Overrides:

remove in class HashMap<String,T>

putAll

public void putAll(Map<? extends String,? extends T> m)

The keys in the given map are interpreted case-insensitive.

Specified by:

putAll in interface Map<String,T>

Overrides:

putAll in class HashMap<String,T>

getOrDefault

public T getOrDefault(Object key,
 T defaultValue)

Specified by:

getOrDefault in interface Map<String,T>

Overrides:

getOrDefault in class HashMap<String,T>