LinkedCaseInsensitiveMap (Toolsverse API Reference 5.9)

Object
- com.toolsverse.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

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface Map
  Map.Entry<K,V>

Constructor Summary

Constructors
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, 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).
`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 and Description
`void`	`clear()`
`LinkedCaseInsensitiveMap<V>`	`clone()`
`V`	`computeIfAbsent(String key, Function<? super String,? extends V> mappingFunction)`
`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 this `LinkedCaseInsensitiveMap`.
`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`	`putIfAbsent(String key, V value)`
`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 Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Map
compute, computeIfPresent, forEach, merge, 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(@Nullable
                                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,
                                @Nullable
                                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)
- Method Detail
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<String,V>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<String,V>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<String,V>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<String,V>
  - get
```
@Nullable
public V get(Object key)
```
    Specified by:
    
    get in interface Map<String,V>
  - getOrDefault
```
@Nullable
public V getOrDefault(Object key,
                                 V defaultValue)
```
    Specified by:
    
    getOrDefault in interface Map<String,V>
  - put
```
@Nullable
public V put(String key,
                        @Nullable
                        V value)
```
    Specified by:
    
    put in interface Map<String,V>
  - putAll
```
public void putAll(Map<? extends String,? extends V> map)
```
    Specified by:
    
    putAll in interface Map<String,V>
  - putIfAbsent
```
@Nullable
public V putIfAbsent(String key,
                                @Nullable
                                V value)
```
    Specified by:
    
    putIfAbsent in interface Map<String,V>
  - computeIfAbsent
```
@Nullable
public V computeIfAbsent(String key,
                                    Function<? super String,? extends V> mappingFunction)
```
    Specified by:
    
    computeIfAbsent in interface Map<String,V>
  - remove
```
@Nullable
public V remove(Object key)
```
    Specified by:
    
    remove in interface Map<String,V>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<String,V>
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Map<String,V>
  - values
```
public Collection<V> values()
```
    Specified by:
    
    values in interface Map<String,V>
  - entrySet
```
public Set<Map.Entry<String,V>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<String,V>
  - clone
```
public LinkedCaseInsensitiveMap<V> clone()
```
    Overrides:
    
    clone in class Object
  - equals
```
public boolean equals(@Nullable
                      Object other)
```
    Specified by:
    
    equals in interface Map<String,V>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<String,V>
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getLocale
```
public 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 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>)

Class LinkedCaseInsensitiveMap<V>

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Constructor Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface Map

Constructor Detail

LinkedCaseInsensitiveMap

LinkedCaseInsensitiveMap

LinkedCaseInsensitiveMap

LinkedCaseInsensitiveMap

Method Detail

size

isEmpty

containsKey

containsValue

get

getOrDefault

put

putAll

putIfAbsent

computeIfAbsent

remove

clear

keySet

values

entrySet

clone

equals

hashCode

toString

getLocale

convertKey

removeEldestEntry