edu.tum.cs.commons.collections
Class ArrayBackedMap<K,V>

java.lang.Object
  edu.tum.cs.commons.collections.ArrayBackedMap<K,V>

All Implemented Interfaces:

java.util.Map<K,V>

Direct Known Subclasses:

ArrayBackedStringMap

public class ArrayBackedMap<K,V>
extends java.lang.Object
implements java.util.Map<K,V>

A map implementation based on unsorted arrays. This is by far more memory efficient than the usual map implementations and has reasonable performance for small maps. Note that this map violates the map interface by just returning copies for the set accessor methods (entrySet(), values(), keySet()), i.e. they are not backed by the map.

Implementation hints:

• Nearly all operations require a full traversal of the array (resp. PairList).
• Iteration is performed backwards, to avoid frequent calls to size() method. This also gives more efficient access to recently added elements.
• This class is prepared to support subclasses with more specific keys with more efficient key handling. Thus all keys inserted are preprocessed and comparison of keys can be overwritten.

Version:

$Rev: 28496 $

Author:

hummelb, $Author: deissenb $

Rating:

GREEN Hash: FD4724FBA572E6336FD0EE8890B9CD58

Nested Class Summary

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

java.util.Map.Entry<K,V>

Constructor Summary

ArrayBackedMap()
Constructs a new map with an initial capacity of 4.

ArrayBackedMap(int initialCapacity)
Constructor.

Method Summary

protected boolean	areEqual(K key1, K key2) Template method for comparing two keys for equality.
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
V	get(java.lang.Object key)
protected K	internKey(java.lang.Object key) Template method for calculating an internal key representation.
boolean	isEmpty()
java.util.Set<K>	keySet()
V	put(K key, V value)
void	putAll(java.util.Map<? extends K,? extends V> m)
V	remove(java.lang.Object key)
int	size()
java.util.Collection<V>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

ArrayBackedMap

public ArrayBackedMap()

Constructs a new map with an initial capacity of 4.

ArrayBackedMap

public ArrayBackedMap(int initialCapacity)

Constructor.

Method Detail

clear

public void clear()

Specified by:

clear in interface java.util.Map<K,V>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<K,V>

internKey

protected K internKey(java.lang.Object key)
               throws java.lang.ClassCastException

Template method for calculating an internal key representation. The default implementation just performs a cast. This method may throw a class cast exception if the provided key is not an instance of the key type.

Throws:

java.lang.ClassCastException - if the provided key is not of a suitable class.

areEqual

protected boolean areEqual(K key1,
                           K key2)

Template method for comparing two keys for equality.

get

public V get(java.lang.Object key)

Specified by:

get in interface java.util.Map<K,V>

put

public V put(K key,
             V value)

Specified by:

put in interface java.util.Map<K,V>

remove

public V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<K,V>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<K,V>

entrySet

public java.util.Set<java.util.Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface java.util.Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<K,V>

keySet

public java.util.Set<K> keySet()

Specified by:

keySet in interface java.util.Map<K,V>

putAll

public void putAll(java.util.Map<? extends K,? extends V> m)

Specified by:

putAll in interface java.util.Map<K,V>

size

public int size()

Specified by:

size in interface java.util.Map<K,V>

values

public java.util.Collection<V> values()

Specified by:

values in interface java.util.Map<K,V>