LinkedCaseInsensitiveMap

java.lang.Object
- org.springframework.util.LinkedCaseInsensitiveMap<V>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,V>
```
public class LinkedCaseInsensitiveMap<V>
extends java.lang.Object
implements java.util.Map<java.lang.String,V>, java.io.Serializable, java.lang.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

Nested Class Summary
- 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 java.util.HashMap<java.lang.String,java.lang.String>`	`caseInsensitiveKeys`
`private java.util.Locale`	`locale`
`private java.util.LinkedHashMap<java.lang.String,V>`	`targetMap`

Constructor Summary

Constructors
Modifier	Constructor and 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 a `LinkedHashMap` with the given initial capacity and stores case-insensitive keys according to the default Locale (by default in lower case).
	`LinkedCaseInsensitiveMap(int initialCapacity, java.util.Locale locale)` Create a new LinkedCaseInsensitiveMap that wraps a `LinkedHashMap` with the given initial capacity and stores case-insensitive keys according to the given Locale (by default in lower case).
`private`	`LinkedCaseInsensitiveMap(LinkedCaseInsensitiveMap<V> other)` Copy constructor.
	`LinkedCaseInsensitiveMap(java.util.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 and Description
`void`	`clear()`
`LinkedCaseInsensitiveMap<V>`	`clone()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`protected java.lang.String`	`convertKey(java.lang.String key)` Convert the given key to a case-insensitive key.
`java.util.Set<java.util.Map.Entry<java.lang.String,V>>`	`entrySet()`
`boolean`	`equals(java.lang.Object obj)`
`V`	`get(java.lang.Object key)`
`java.util.Locale`	`getLocale()` Return the locale used by this `LinkedCaseInsensitiveMap`.
`V`	`getOrDefault(java.lang.Object key, V defaultValue)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`java.util.Set<java.lang.String>`	`keySet()`
`V`	`put(java.lang.String key, V value)`
`void`	`putAll(java.util.Map<? extends java.lang.String,? extends V> map)`
`V`	`remove(java.lang.Object key)`
`protected boolean`	`removeEldestEntry(java.util.Map.Entry<java.lang.String,V> eldest)` Determine whether this map should remove the given eldest entry.
`int`	`size()`
`java.lang.String`	`toString()`
`java.util.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

- Field Detail
  - targetMap
```
private final java.util.LinkedHashMap<java.lang.String,V> targetMap
```
  - caseInsensitiveKeys
```
private final java.util.HashMap<java.lang.String,java.lang.String> caseInsensitiveKeys
```
  - locale
```
private final java.util.Locale locale
```
- 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(java.util.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 a LinkedHashMap 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,
                                java.util.Locale locale)
```
    Create a new LinkedCaseInsensitiveMap that wraps a LinkedHashMap with the given initial capacity and stores case-insensitive keys according to the given Locale (by default in lower case).
    
    Parameters:
    
    initialCapacity - the initial capacity
    
    locale - the Locale to use for case-insensitive key conversion
    
    See Also:
    
    convertKey(String)
  - LinkedCaseInsensitiveMap
```
private LinkedCaseInsensitiveMap(LinkedCaseInsensitiveMap<V> other)
```
    Copy constructor.
- Method Detail
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<java.lang.String,V>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<java.lang.String,V>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<java.lang.String,V>
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<java.lang.String,V>
  - get
```
public V get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<java.lang.String,V>
  - getOrDefault
```
public V getOrDefault(java.lang.Object key,
                      V defaultValue)
```
    Specified by:
    
    getOrDefault in interface java.util.Map<java.lang.String,V>
  - put
```
public V put(java.lang.String key,
             V value)
```
    Specified by:
    
    put in interface java.util.Map<java.lang.String,V>
  - putAll
```
public void putAll(java.util.Map<? extends java.lang.String,? extends V> map)
```
    Specified by:
    
    putAll in interface java.util.Map<java.lang.String,V>
  - remove
```
public V remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<java.lang.String,V>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.String,V>
  - keySet
```
public java.util.Set<java.lang.String> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.String,V>
  - values
```
public java.util.Collection<V> values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.String,V>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<java.lang.String,V>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<java.lang.String,V>
  - clone
```
public LinkedCaseInsensitiveMap<V> clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Specified by:
    
    equals in interface java.util.Map<java.lang.String,V>
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map<java.lang.String,V>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getLocale
```
public java.util.Locale getLocale()
```
    Return the locale used by this LinkedCaseInsensitiveMap. Used for case-insensitive key conversion.
    
    Since:
    
    4.3.10
    
    See Also:
    
    LinkedCaseInsensitiveMap(Locale), convertKey(String)
  - convertKey
```
protected java.lang.String convertKey(java.lang.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(java.util.Map.Entry<java.lang.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>)

Class LinkedCaseInsensitiveMap<V>

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

targetMap

caseInsensitiveKeys

locale

Constructor Detail

LinkedCaseInsensitiveMap

LinkedCaseInsensitiveMap

LinkedCaseInsensitiveMap

LinkedCaseInsensitiveMap

LinkedCaseInsensitiveMap

Method Detail

size

isEmpty

containsKey

containsValue

get

getOrDefault

put

putAll

remove

clear

keySet

values

entrySet

clone

equals

hashCode

toString

getLocale

convertKey

removeEldestEntry