Package org.springframework.util
Class LinkedCaseInsensitiveMap<V>
- java.lang.Object
- org.springframework.util.LinkedCaseInsensitiveMap<V>
- Type Parameters:
V
- the value type
- All Implemented Interfaces:
Serializable
,Cloneable
,Map<String,V>
public class LinkedCaseInsensitiveMap<V> extends Object implements Map<String,V>, Serializable, Cloneable
LinkedHashMap
variant that stores String keys in a case-insensitive manner, for example for key-based access in a results table.Preserves the original order as well as the original casing of keys, while allowing for contains, get and remove calls with any case of key.
Does not support
null
keys.- Since:
- 3.0
- Author:
- Juergen Hoeller
- See Also:
- Serialized Form
Constructor Summary
Constructors Constructor Description LinkedCaseInsensitiveMap()
Create a new LinkedCaseInsensitiveMap that stores case-insensitive keys according to the default Locale (by default in lower case).LinkedCaseInsensitiveMap(int initialCapacity)
Create a new LinkedCaseInsensitiveMap that wraps aLinkedHashMap
with the given initial capacity and stores case-insensitive keys according to the default Locale (by default in lower case).LinkedCaseInsensitiveMap(int initialCapacity, Locale locale)
Create a new LinkedCaseInsensitiveMap that wraps aLinkedHashMap
with the given initial capacity and stores case-insensitive keys according to the given Locale (by default in lower case).LinkedCaseInsensitiveMap(Locale locale)
Create a new LinkedCaseInsensitiveMap that stores case-insensitive keys according to the given Locale (by default in lower case).
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
LinkedCaseInsensitiveMap<V>
clone()
boolean
containsKey(Object key)
boolean
containsValue(Object value)
protected String
convertKey(String key)
Convert the given key to a case-insensitive key.Set<Map.Entry<String,V>>
entrySet()
boolean
equals(Object other)
V
get(Object key)
Locale
getLocale()
Return the locale used by thisLinkedCaseInsensitiveMap
.V
getOrDefault(Object key, V defaultValue)
int
hashCode()
boolean
isEmpty()
Set<String>
keySet()
V
put(String key, V value)
void
putAll(Map<? extends String,? extends V> map)
V
remove(Object key)
protected boolean
removeEldestEntry(Map.Entry<String,V> eldest)
Determine whether this map should remove the given eldest entry.int
size()
String
toString()
Collection<V>
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, merge, putIfAbsent, remove, replace, replace, replaceAll
Constructor Detail
LinkedCaseInsensitiveMap
public LinkedCaseInsensitiveMap()
Create a new LinkedCaseInsensitiveMap that stores case-insensitive keys according to the default Locale (by default in lower case).- See Also:
convertKey(String)
LinkedCaseInsensitiveMap
public LinkedCaseInsensitiveMap(Locale locale)
Create a new LinkedCaseInsensitiveMap that stores case-insensitive keys according to the given Locale (by default in lower case).- Parameters:
locale
- the Locale to use for case-insensitive key conversion- See Also:
convertKey(String)
LinkedCaseInsensitiveMap
public LinkedCaseInsensitiveMap(int initialCapacity)
Create a new LinkedCaseInsensitiveMap that wraps aLinkedHashMap
with the given initial capacity and stores case-insensitive keys according to the default Locale (by default in lower case).- Parameters:
initialCapacity
- the initial capacity- See Also:
convertKey(String)
LinkedCaseInsensitiveMap
public LinkedCaseInsensitiveMap(int initialCapacity, Locale locale)
Create a new LinkedCaseInsensitiveMap that wraps aLinkedHashMap
with the given initial capacity and stores case-insensitive keys according to the given Locale (by default in lower case).- Parameters:
initialCapacity
- the initial capacitylocale
- the Locale to use for case-insensitive key conversion- See Also:
convertKey(String)
Method Detail
containsKey
public boolean containsKey(Object key)
- Specified by:
containsKey
in interfaceMap<String,V>
containsValue
public boolean containsValue(Object value)
- Specified by:
containsValue
in interfaceMap<String,V>
getOrDefault
public V getOrDefault(Object key, V defaultValue)
- Specified by:
getOrDefault
in interfaceMap<String,V>
clone
public LinkedCaseInsensitiveMap<V> clone()
hashCode
public int hashCode()
getLocale
public Locale getLocale()
Return the locale used by thisLinkedCaseInsensitiveMap
. Used for case-insensitive key conversion.- Since:
- 4.3.10
- See Also:
LinkedCaseInsensitiveMap(Locale)
,convertKey(String)
convertKey
protected String convertKey(String key)
Convert the given key to a case-insensitive key.The default implementation converts the key to lower-case according to this Map's Locale.
- Parameters:
key
- the user-specified key- Returns:
- the key to use for storing
- See Also:
String.toLowerCase(Locale)
removeEldestEntry
protected boolean removeEldestEntry(Map.Entry<String,V> eldest)
Determine whether this map should remove the given eldest entry.- Parameters:
eldest
- the candidate entry- Returns:
true
for removing it,false
for keeping it- See Also:
LinkedHashMap.removeEldestEntry(java.util.Map.Entry<K, V>)