net.aavalla.utils.general
Class RetrievalHashMap<K,V>

java.lang.Object
  extended by net.aavalla.utils.general.RetrievalAbstractMap<K,V>
      extended by net.aavalla.utils.general.RetrievalHashMap<K,V>
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map<K,V>

public class RetrievalHashMap<K,V>
extends RetrievalAbstractMap<K,V>
implements java.util.Map<K,V>, java.lang.Cloneable, java.io.Serializable

RetrievalHashMap is an implementation of Map. All optional operations (adding and removing) are supported. Keys and values can be any objects.

See Also:
Serialized Form

Constructor Summary
RetrievalHashMap()
          Constructs a new empty RetrievalHashMap instance.
RetrievalHashMap(int capacity)
          Constructs a new RetrievalHashMap instance with the specified capacity.
RetrievalHashMap(int capacity, float loadFactor)
          Constructs a new RetrievalHashMap instance with the specified capacity and load factor.
RetrievalHashMap(java.util.Map<? extends K,? extends V> map)
          Constructs a new RetrievalHashMap instance containing the mappings from the specified map.
 
Method Summary
 void clear()
          Removes all mappings from this hash map, leaving it empty.
 java.lang.Object clone()
          Returns a shallow copy of this map.
 boolean containsKey(java.lang.Object key)
          Returns whether this map contains the specified key.
 boolean containsValue(java.lang.Object value)
          Returns whether this map contains the specified value.
 java.util.Set<java.util.Map.Entry<K,V>> entrySet()
          Returns a set containing all of the mappings in this map.
 V get(java.lang.Object key)
          Returns the value of the mapping with the specified key.
 K getKey(K templateKey)
          Returns a key from this map that equals with the key given as argument or null, if none exist.
 boolean isEmpty()
          Returns whether this map is empty.
 java.util.Set<K> keySet()
          Returns a set of the keys contained in this map.
 V put(K key, V value)
          Maps the specified key to the specified value.
 void putAll(java.util.Map<? extends K,? extends V> map)
          Copies all the mappings in the specified map to this map.
 V remove(java.lang.Object key)
          Removes the mapping with the specified key from this map.
 int size()
          Returns the number of elements in this map.
 java.util.Collection<V> values()
          Returns a collection of the values contained in this map.
 
Methods inherited from class net.aavalla.utils.general.RetrievalAbstractMap
equals, hashCode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Constructor Detail

RetrievalHashMap

public RetrievalHashMap()
Constructs a new empty RetrievalHashMap instance.


RetrievalHashMap

public RetrievalHashMap(int capacity)
Constructs a new RetrievalHashMap instance with the specified capacity.

Parameters:
capacity - the initial capacity of this hash map.
Throws:
java.lang.IllegalArgumentException - when the capacity is less than zero.

RetrievalHashMap

public RetrievalHashMap(int capacity,
                        float loadFactor)
Constructs a new RetrievalHashMap instance with the specified capacity and load factor.

Parameters:
capacity - the initial capacity of this hash map.
loadFactor - the initial load factor.
Throws:
java.lang.IllegalArgumentException - when the capacity is less than zero or the load factor is less or equal to zero.

RetrievalHashMap

public RetrievalHashMap(java.util.Map<? extends K,? extends V> map)
Constructs a new RetrievalHashMap instance containing the mappings from the specified map.

Parameters:
map - the mappings to add.
Method Detail

clear

public void clear()
Removes all mappings from this hash map, leaving it empty.

Specified by:
clear in interface java.util.Map<K,V>
Overrides:
clear in class RetrievalAbstractMap<K,V>
See Also:
isEmpty(), size()

clone

public java.lang.Object clone()
Returns a shallow copy of this map.

Overrides:
clone in class RetrievalAbstractMap<K,V>
Returns:
a shallow copy of this map.

containsKey

public boolean containsKey(java.lang.Object key)
Returns whether this map contains the specified key.

Specified by:
containsKey in interface java.util.Map<K,V>
Overrides:
containsKey in class RetrievalAbstractMap<K,V>
Parameters:
key - the key to search for.
Returns:
true if this map contains the specified key, false otherwise.

getKey

public K getKey(K templateKey)
Returns a key from this map that equals with the key given as argument or null, if none exist. Note that hashCode() and equals() are used in this comparison.

Parameters:
templateKey - key template to search for
Returns:
equal key from this map or null

containsValue

public boolean containsValue(java.lang.Object value)
Returns whether this map contains the specified value.

Specified by:
containsValue in interface java.util.Map<K,V>
Overrides:
containsValue in class RetrievalAbstractMap<K,V>
Parameters:
value - the value to search for.
Returns:
true if this map contains the specified value, false otherwise.

entrySet

public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
Returns a set containing all of the mappings in this map. Each mapping is an instance of Map.Entry. As the set is backed by this map, changes in one will be reflected in the other.

Specified by:
entrySet in interface java.util.Map<K,V>
Specified by:
entrySet in class RetrievalAbstractMap<K,V>
Returns:
a set of the mappings.

get

public V get(java.lang.Object key)
Returns the value of the mapping with the specified key.

Specified by:
get in interface java.util.Map<K,V>
Overrides:
get in class RetrievalAbstractMap<K,V>
Parameters:
key - the key.
Returns:
the value of the mapping with the specified key, or null if no mapping for the specified key is found.

isEmpty

public boolean isEmpty()
Returns whether this map is empty.

Specified by:
isEmpty in interface java.util.Map<K,V>
Overrides:
isEmpty in class RetrievalAbstractMap<K,V>
Returns:
true if this map has no elements, false otherwise.
See Also:
size()

keySet

public java.util.Set<K> keySet()
Returns a set of the keys contained in this map. The set is backed by this map so changes to one are reflected by the other. The set does not support adding.

Specified by:
keySet in interface java.util.Map<K,V>
Overrides:
keySet in class RetrievalAbstractMap<K,V>
Returns:
a set of the keys.

put

public V put(K key,
             V value)
Maps the specified key to the specified value.

Specified by:
put in interface java.util.Map<K,V>
Overrides:
put in class RetrievalAbstractMap<K,V>
Parameters:
key - the key.
value - the value.
Returns:
the value of any previous mapping with the specified key or null if there was no such mapping.

putAll

public void putAll(java.util.Map<? extends K,? extends V> map)
Copies all the mappings in the specified map to this map. These mappings will replace all mappings that this map had for any of the keys currently in the given map.

Specified by:
putAll in interface java.util.Map<K,V>
Overrides:
putAll in class RetrievalAbstractMap<K,V>
Parameters:
map - the map to copy mappings from.
Throws:
java.lang.NullPointerException - if map is null.

remove

public V remove(java.lang.Object key)
Removes the mapping with the specified key from this map.

Specified by:
remove in interface java.util.Map<K,V>
Overrides:
remove in class RetrievalAbstractMap<K,V>
Parameters:
key - the key of the mapping to remove.
Returns:
the value of the removed mapping or null if no mapping for the specified key was found.

size

public int size()
Returns the number of elements in this map.

Specified by:
size in interface java.util.Map<K,V>
Overrides:
size in class RetrievalAbstractMap<K,V>
Returns:
the number of elements in this map.

values

public java.util.Collection<V> values()
Returns a collection of the values contained in this map. The collection is backed by this map so changes to one are reflected by the other. The collection supports remove, removeAll, retainAll and clear operations, and it does not support add or addAll operations.

This method returns a collection which is the subclass of AbstractCollection. The iterator method of this subclass returns a "wrapper object" over the iterator of map's entrySet(). The size method wraps the map's size method and the contains method wraps the map's containsValue method.

The collection is created when this method is called for the first time and returned in response to all subsequent calls. This method may return different collections when multiple concurrent calls occur, since no synchronization is performed.

Specified by:
values in interface java.util.Map<K,V>
Overrides:
values in class RetrievalAbstractMap<K,V>
Returns:
a collection of the values contained in this map.