| org.apache.commons.collections.map.AbstractHashedMap org.apache.commons.collections.map.CaseInsensitiveMap
CaseInsensitiveMap | public class CaseInsensitiveMap extends AbstractHashedMap implements Serializable,Cloneable(Code) | | 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}.
Note that CaseInsensitiveMap is not synchronized and is not thread-safe.
If you wish to use this map from multiple threads concurrently, you must use
appropriate synchronization. The simplest approach is to wrap this map
using
java.util.Collections.synchronizedMap(Map) . This class may throw
exceptions when accessed by concurrent threads without synchronization.
since: Commons Collections 3.0 version: $Revision: 348007 $ $Date: 2005-11-21 22:52:57 +0000 (Mon, 21 Nov 2005) $ author: Commons-Collections team |
Constructor Summary | |
public | CaseInsensitiveMap() Constructs a new empty map with default size and load factor. | public | CaseInsensitiveMap(int initialCapacity) Constructs a new, empty map with the specified initial capacity. | public | CaseInsensitiveMap(int initialCapacity, float loadFactor) Constructs a new, empty map with the specified initial capacity and
load factor. | public | CaseInsensitiveMap(Map map) Constructor copying elements from another map. |
CaseInsensitiveMap | public CaseInsensitiveMap()(Code) | | Constructs a new empty map with default size and load factor.
|
CaseInsensitiveMap | public CaseInsensitiveMap(int initialCapacity)(Code) | | Constructs a new, empty map with the specified initial capacity.
Parameters: initialCapacity - the initial capacity throws: IllegalArgumentException - if the initial capacity is less than one |
CaseInsensitiveMap | public CaseInsensitiveMap(int initialCapacity, float loadFactor)(Code) | | Constructs a new, empty map with the specified initial capacity and
load factor.
Parameters: initialCapacity - the initial capacity Parameters: loadFactor - the load factor throws: IllegalArgumentException - if the initial capacity is less than one throws: IllegalArgumentException - if the load factor is less than zero |
CaseInsensitiveMap | public CaseInsensitiveMap(Map map)(Code) | | 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: NullPointerException - if the map is null |
clone | public Object clone()(Code) | | Clones the map without cloning the keys or values.
a shallow clone |
convertKey | protected Object convertKey(Object key)(Code) | | Overrides convertKey() from
AbstractHashedMap to convert keys to
lower case.
Returns null if key is null.
Parameters: key - the key convert the converted key |
Methods inherited from org.apache.commons.collections.map.AbstractHashedMap | protected void addEntry(HashEntry entry, int hashIndex)(Code)(Java Doc) protected void addMapping(int hashIndex, int hashCode, Object key, Object value)(Code)(Java Doc) protected int calculateNewCapacity(int proposedCapacity)(Code)(Java Doc) protected int calculateThreshold(int newCapacity, float factor)(Code)(Java Doc) protected void checkCapacity()(Code)(Java Doc) public void clear()(Code)(Java Doc) protected Object clone()(Code)(Java Doc) public boolean containsKey(Object key)(Code)(Java Doc) public boolean containsValue(Object value)(Code)(Java Doc) protected Object convertKey(Object key)(Code)(Java Doc) protected HashEntry createEntry(HashEntry next, int hashCode, Object key, Object value)(Code)(Java Doc) protected Iterator createEntrySetIterator()(Code)(Java Doc) protected Iterator createKeySetIterator()(Code)(Java Doc) protected Iterator createValuesIterator()(Code)(Java Doc) protected void destroyEntry(HashEntry entry)(Code)(Java Doc) protected void doReadObject(ObjectInputStream in) throws IOException, ClassNotFoundException(Code)(Java Doc) protected void doWriteObject(ObjectOutputStream out) throws IOException(Code)(Java Doc) protected void ensureCapacity(int newCapacity)(Code)(Java Doc) protected int entryHashCode(HashEntry entry)(Code)(Java Doc) protected Object entryKey(HashEntry entry)(Code)(Java Doc) protected HashEntry entryNext(HashEntry entry)(Code)(Java Doc) public Set entrySet()(Code)(Java Doc) protected Object entryValue(HashEntry entry)(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) public Object get(Object key)(Code)(Java Doc) protected HashEntry getEntry(Object key)(Code)(Java Doc) protected int hash(Object key)(Code)(Java Doc) public int hashCode()(Code)(Java Doc) protected int hashIndex(int hashCode, int dataSize)(Code)(Java Doc) protected void init()(Code)(Java Doc) public boolean isEmpty()(Code)(Java Doc) protected boolean isEqualKey(Object key1, Object key2)(Code)(Java Doc) protected boolean isEqualValue(Object value1, Object value2)(Code)(Java Doc) public Set keySet()(Code)(Java Doc) public MapIterator mapIterator()(Code)(Java Doc) public Object put(Object key, Object value)(Code)(Java Doc) public void putAll(Map map)(Code)(Java Doc) public Object remove(Object key)(Code)(Java Doc) protected void removeEntry(HashEntry entry, int hashIndex, HashEntry previous)(Code)(Java Doc) protected void removeMapping(HashEntry entry, int hashIndex, HashEntry previous)(Code)(Java Doc) protected void reuseEntry(HashEntry entry, int hashIndex, int hashCode, Object key, Object value)(Code)(Java Doc) public int size()(Code)(Java Doc) public String toString()(Code)(Java Doc) protected void updateEntry(HashEntry entry, Object newValue)(Code)(Java Doc) public Collection values()(Code)(Java Doc)
|
|
|