⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.map

Class CaseInsensitiveMap

java.lang.Object
|
+--org.apache.commons.collections.map.AbstractHashedMap
   |
   +--org.apache.commons.collections.map.CaseInsensitiveMap

All Implemented Interfaces:
Cloneable, IterableMap, Serializable


public class CaseInsensitiveMap
extends AbstractHashedMap
implements Serializable, Cloneable

A case-insensitive Map.

As entries are added to the map, keys are converted to all lowercase. A new key is compared to existing keys by comparing newKey.toString().toLower() to the lowercase values in the current KeySet.

Null keys are supported.

The keySet() method returns all lowercase keys, or nulls.

Example:

  Map map = new CaseInsensitiveMap();
  map.put("One", "One");
  map.put("Two", "Two");
  map.put(null, "Three");
  map.put("one", "Four");
creates a CaseInsensitiveMap with three entries.
map.get(null) returns "Three" and map.get("ONE") returns "Four". The Set returned by keySet() equals {"one", "two", null}.
Since:
Commons Collections 3.0
Author:
Commons-Collections team

Constructor Summary

CaseInsensitiveMap()

Constructs a new empty map with default size and load factor.

CaseInsensitiveMap(int initialCapacity)

Constructs a new, empty map with the specified initial capacity.

CaseInsensitiveMap(int initialCapacity, float loadFactor)

Constructs a new, empty map with the specified initial capacity and load factor.

CaseInsensitiveMap(Map map)

Constructor copying elements from another map.

Method Summary

Object

clone()

Clones the map without cloning the keys or values.

Object

convertKey(Object key)

Overrides convertKey() from AbstractHashedMap to convert keys to lower case.

Constructor Details

CaseInsensitiveMap

public CaseInsensitiveMap()

Constructs a new empty map with default size and load factor.


CaseInsensitiveMap

public CaseInsensitiveMap(int initialCapacity, float loadFactor)

Constructs a new, empty map with the specified initial capacity and load factor.

Parameters:
initialCapacity - the initial capacity
loadFactor - the load factor
Throws:
- if the initial capacity is less than one
- if the load factor is less than zero

CaseInsensitiveMap

public CaseInsensitiveMap(int initialCapacity)

Constructs a new, empty map with the specified initial capacity.

Parameters:
initialCapacity - the initial capacity
Throws:
- if the initial capacity is less than one

CaseInsensitiveMap

public CaseInsensitiveMap(Map map)

Constructor copying elements from another map.

Keys will be converted to lower case strings, which may cause some entries to be removed (if string representation of keys differ only by character case).

Parameters:
map - the map to copy
Throws:
- if the map is null

Method Details

clone

public Object clone()

Clones the map without cloning the keys or values.

Returns:
a shallow clone

convertKey

protected Object convertKey(Object key)

Overrides convertKey() from AbstractHashedMap to convert keys to lower case.

Returns null if key is null.

Parameters:
key - the key convert
Returns:
the converted key