UserHashMap (WGAPI 7.0)

java.lang.Object
- de.innovationgate.utils.UserHashMap<KeyType,ValueType>

All Implemented Interfaces:

java.util.Map<KeyType,ValueType>
```
public class UserHashMap<KeyType,ValueType>
extends java.lang.Object
implements java.util.Map<KeyType,ValueType>
```
A Map that contains different maps for different users identified by a unique user name.
The UserHashMap may be regarded a "ThreadLocal" Map where every thread may have it's own private map. Main difference to ThreadLoval: Every thread may choose from a list of available maps where each map belongs to a single user.

UserHashMaps belong to UserHashMapGroup objects. A UserHashMapGroup collects UserHashMaps that should switch to the same users map at the same time. The UserHashMapGroup hosts methods for creating new UserHashMaps (UserHashMapGroup.newUserHashMap(String)) and for switching all of the maps in the group to a specified user (UserHashMapGroup.fetchAllMapsForUser(String)).

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears all entries from all users maps.
`void`	`clearUser()` Clears the entries of the current users map.
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set<java.util.Map.Entry<KeyType,ValueType>>`	`entrySet()`
`ValueType`	`get(java.lang.Object key)`
`java.util.Map<KeyType,ValueType>`	`getCurrentUserMap()` Returns the currently served map as a single map.
`UserHashMapGroup`	`getGroup()` Returns the parent UserHashMapGroup object
`java.util.Map<KeyType,ValueType>`	`getMapForUser(java.lang.String user)` Returns the map for a specific user without switching the methods of the normal map interface to this map.
`long`	`getMapLatency()` Returns the map latency in milliseconds.
`int`	`getUserCount()` Returns the number of users who have own hashmaps
`java.util.Map<java.lang.String,de.innovationgate.utils.UserHashMap.SingleUserMap>`	`getUserMaps()` Returns a map of user's hash maps.
`boolean`	`isEmpty()`
`java.util.Set<KeyType>`	`keySet()`
`ValueType`	`put(KeyType key, ValueType value)`
`void`	`putAll(java.util.Map<? extends KeyType,? extends ValueType> t)`
`ValueType`	`remove(java.lang.Object key)`
`void`	`removeFromAllUsers(KeyType key)` Removes a map key from all users maps
`void`	`removeFromAllUsers(KeyType key, ValueType value)` Removes a map key from all users maps If parameter value is given it only removes those keys that map equal values.
`void`	`setMapLatency(long mapLatency)` Sets the latency of the map.
`int`	`size()`
`java.util.Collection<ValueType>`	`values()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map
equals, hashCode

- Method Detail
  - getMapForUser
```
public java.util.Map<KeyType,ValueType> getMapForUser(java.lang.String user)
```
    Returns the map for a specific user without switching the methods of the normal map interface to this map.
    
    Parameters:
    user -
  - getCurrentUserMap
```
public java.util.Map<KeyType,ValueType> getCurrentUserMap()
```
    Returns the currently served map as a single map.
  - get
```
public ValueType get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<KeyType,ValueType>
  - put
```
public ValueType put(KeyType key,
            ValueType value)
```
    Specified by:
    
    put in interface java.util.Map<KeyType,ValueType>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<KeyType,ValueType>
    
    See Also:
    Map.containsKey(Object)
  - clear
```
public void clear()
```
    Clears all entries from all users maps. For clearing the entries for a single user see clearUser().
    
    Specified by:
    
    clear in interface java.util.Map<KeyType,ValueType>
  - clearUser
```
public void clearUser()
```
    Clears the entries of the current users map.
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<KeyType,ValueType>
    
    See Also:
    Map.containsValue(Object)
  - entrySet
```
public java.util.Set<java.util.Map.Entry<KeyType,ValueType>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<KeyType,ValueType>
    
    See Also:
    Map.entrySet()
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<KeyType,ValueType>
    
    See Also:
    Map.isEmpty()
  - keySet
```
public java.util.Set<KeyType> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<KeyType,ValueType>
    
    See Also:
    Map.keySet()
  - putAll
```
public void putAll(java.util.Map<? extends KeyType,? extends ValueType> t)
```
    Specified by:
    
    putAll in interface java.util.Map<KeyType,ValueType>
    
    See Also:
    Map.putAll(Map)
  - removeFromAllUsers
```
public void removeFromAllUsers(KeyType key,
                      ValueType value)
```
    Removes a map key from all users maps If parameter value is given it only removes those keys that map equal values.
    
    Parameters:
    key - The key to remove
    value - A value that must match the value mapped to key if the key should be removed. Specify null to remove the key in any case.
  - removeFromAllUsers
```
public void removeFromAllUsers(KeyType key)
```
    Removes a map key from all users maps
    
    Parameters:
    key - The key to remove
  - remove
```
public ValueType remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<KeyType,ValueType>
    
    See Also:
    Map.remove(Object)
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<KeyType,ValueType>
    
    See Also:
    Map.size()
  - values
```
public java.util.Collection<ValueType> values()
```
    Specified by:
    
    values in interface java.util.Map<KeyType,ValueType>
    
    See Also:
    Map.values()
  - getUserCount
```
public int getUserCount()
```
    Returns the number of users who have own hashmaps
  - getGroup
```
public UserHashMapGroup getGroup()
```
    Returns the parent UserHashMapGroup object
  - getUserMaps
```
public java.util.Map<java.lang.String,de.innovationgate.utils.UserHashMap.SingleUserMap> getUserMaps()
```
    Returns a map of user's hash maps. The keys are the user names, the values are the single maps themselves.
  - getMapLatency
```
public long getMapLatency()
```
    Returns the map latency in milliseconds.
  - setMapLatency
```
public void setMapLatency(long mapLatency)
```
    Sets the latency of the map. If a latency other as 0 (the default) is specified the map will have a lifetime of the given latency in milliseconds. After that time the map is dicarded and a new empty one is created. This is helpful to cache user-specific data that should be discarded after some time.
    
    Parameters:
    mapLatency -

Class UserHashMap<KeyType,ValueType>

Nested Class Summary

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

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Method Detail

getMapForUser

getCurrentUserMap

get

put

containsKey

clear

clearUser

containsValue

entrySet

isEmpty

keySet

putAll

removeFromAllUsers

removeFromAllUsers

remove

size

values

getUserCount

getGroup

getUserMaps

getMapLatency

setMapLatency