CaseInsensitiveMap (java-util 1.6.0 API)

java.lang.Object
- com.cedarsoftware.util.CaseInsensitiveMap<K,V>

All Implemented Interfaces:

Map<K,V>
```
public class CaseInsensitiveMap<K,V>
extends Object
implements Map<K,V>
```
Useful Map that does not care about the case-sensitivity of keys when the key value is a String. Other key types can be used. String keys will be treated case insensitively, yet key case will be retained. Non-string keys will work as they normally would.
The internal CaseInsentitiveString is never exposed externally from this class. When requesting the keys or entries of this map, or calling containsKey() or get() for example, use a String as you normally would. The returned Set of keys for the keySet() and entrySet() APIs return the original Strings, not the internally wrapped CaseInsensitiveString.

Author:

John DeRegnaucourt ([email protected])
Copyright (c) John DeRegnaucourt

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

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

Constructor Summary

Constructors
Constructor and Description
`CaseInsensitiveMap()`
`CaseInsensitiveMap(int initialCapacity)`
`CaseInsensitiveMap(int initialCapacity, float loadFactor)`
`CaseInsensitiveMap(Map<? extends K,? extends V> map)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<K,V>>`	`entrySet()`
`boolean`	`equals(Object other)`
`V`	`get(Object key)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Set<K>`	`keySet()`
`V`	`put(K key, V value)`
`void`	`putAll(Map<? extends K,? extends V> m)`
`V`	`remove(Object key)`
`int`	`size()`
`String`	`toString()`
`Collection<V>`	`values()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CaseInsensitiveMap
```
public CaseInsensitiveMap()
```
  - CaseInsensitiveMap
```
public CaseInsensitiveMap(int initialCapacity)
```
  - CaseInsensitiveMap
```
public CaseInsensitiveMap(Map<? extends K,? extends V> map)
```
  - CaseInsensitiveMap
```
public CaseInsensitiveMap(int initialCapacity,
                  float loadFactor)
```
- Method Detail
  - get
```
public V get(Object key)
```
    Specified by:
    
    get in interface Map<K,V>
  - put
```
public V put(K key,
    V value)
```
    Specified by:
    
    put in interface Map<K,V>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<K,V>
  - putAll
```
public void putAll(Map<? extends K,? extends V> m)
```
    Specified by:
    
    putAll in interface Map<K,V>
  - remove
```
public V remove(Object key)
```
    Specified by:
    
    remove in interface Map<K,V>
  - keySet
```
public Set<K> keySet()
```
    Specified by:
    
    keySet in interface Map<K,V>
    
    Returns:
    Set of Keys from the Map. This API is implemented to allow this class to unwrap the internal structure placed around String keys, returning them as the original String keys, retaining their case.
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<K,V>
    
    Returns:
    Set of Map.Entry for each entry in the Map. This API is implemented to allow this class to unwrap the internal structure placed around String keys, returning them as the original String keys, retaining their case.
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<K,V>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<K,V>
  - equals
```
public boolean equals(Object other)
```
    Specified by:
    
    equals in interface Map<K,V>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<K,V>
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<K,V>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<K,V>
  - values
```
public Collection<V> values()
```
    Specified by:
    
    values in interface Map<K,V>

Class CaseInsensitiveMap<K,V>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CaseInsensitiveMap

CaseInsensitiveMap

CaseInsensitiveMap

CaseInsensitiveMap

Method Detail

get

put

containsKey

putAll

remove

keySet

entrySet

size

isEmpty

equals

hashCode

toString

clear

containsValue

values