Storage (moskito core 2.9.3 API)

java.lang.Object
- net.anotheria.moskito.core.util.storage.Storage<K,V>

Type Parameters:

K -

V -

All Implemented Interfaces:

java.util.Map<K,V>, Inspectable, IStatsProducer<StorageStats>
```
public class Storage<K,V>
extends java.lang.Object
implements IStatsProducer<StorageStats>, Inspectable, java.util.Map<K,V>
```
This class represents a monitorable, map-like storage.

Author:

lrosenberg

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

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEF_CATEGORY` Default category used for producer registration.
`static java.lang.String`	`DEF_SUBSYSTEM` Default subsystem used for producer registration.

Constructor Summary

Constructors
Constructor and Description
`Storage(StorageWrapper<K,V> aWrapper)` Creates a new anonymous storage with given wrapper.
`Storage(java.lang.String aName, StorageWrapper<K,V> aWrapper)` Creates a new storage with given wrapper.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`static <K,V> Storage<K,V>`	`createConcurrentHashMapStorage()` Factory method to create a new storage backed by a concurrent hash map.
`static <K,V> Storage<K,V>`	`createConcurrentHashMapStorage(int initialSize)` Factory method to create a new storage backed by a concurrent hash map.
`static <K,V> Storage<K,V>`	`createConcurrentHashMapStorage(java.lang.String name)` Factory method to create a new storage backed by a concurrent hash map.
`static <K,V> Storage<K,V>`	`createConcurrentHashMapStorage(java.lang.String name, int initialSize)` Factory method to create a new storage backed by a concurrent hash map.
`static <K,V> Storage<K,V>`	`createHashMapStorage()` Factory method to create a new storage backed by a hashmap.
`static <K,V> Storage<K,V>`	`createHashMapStorage(int initialSize)` Factory method to create a new storage backed by a hashmap.
`static <K,V> Storage<K,V>`	`createHashMapStorage(java.lang.String name)` Factory method to create a new storage backed by a hashmap.
`static <K,V> Storage<K,V>`	`createHashMapStorage(java.lang.String name, int initialSize)` Factory method to create a new storage backed by a concurrent hash map.
`static <K,V> Storage<K,V>`	`createHashtableStorage()` Factory method to create a new storage backed by a hashtable.
`static <K,V> Storage<K,V>`	`createHashtableStorage(int initialSize)` Factory method to create a new storage backed by a hashtable.
`static <K,V> Storage<K,V>`	`createHashtableStorage(java.lang.String name)` Factory method to create a new storage backed by a hashtable.
`static <K,V> Storage<K,V>`	`createHashtableStorage(java.lang.String name, int initialSize)` Factory method to create a new storage backed by a hashtable.
`static <K,V> Storage<K,V>`	`createTreeMapStorage(java.lang.String name)` Creates a new TreeMap backed Storage.
`static <K,V> Storage<K,V>`	`createTreeMapStorage(java.lang.String name, java.util.Comparator comparator)` Creates a new TreeMap backed Storage.
`java.util.Set<java.util.Map.Entry<K,V>>`	`entrySet()`
`java.util.Map<K,V>`	`fillMap(java.util.Map<K,V> toFill)` Puts all elements into a given map.
`V`	`get(java.lang.Object key)`
`java.lang.String`	`getCategory()` Returns the category of this producer.
`CreationInfo`	`getCreationInfo()` Returns the creation info of this object.
`java.lang.String`	`getName()` Returns this storage's name.
`java.lang.String`	`getProducerId()` Returns the meaningful id of this producer.
`java.util.List<StorageStats>`	`getStats()` Returns the list of all stats.
`java.lang.String`	`getSubsystem()` Returns the subsystem the current producer is located in.
`boolean`	`isEmpty()`
`java.util.Collection<K>`	`keys()` Convenience method for old hashtable users.
`java.util.Set<K>`	`keySet()`
`V`	`put(K key, V value)`
`void`	`putAll(java.util.Map<? extends K,? extends V> anotherMap)`
`void`	`putAll(Storage<? extends K,? extends V> anotherStorage)` Puts all elements from anotherStorage to this storage.
`V`	`remove(java.lang.Object key)`
`void`	`setCategory(java.lang.String aCategory)` Sets the category of this producer.
`void`	`setSubsystem(java.lang.String aSubsystem)` Sets the subsystem of this producer.
`int`	`size()`
`java.util.Map<K,V>`	`toMap()` Creates a map copy of this storage with all contained elements.
`void`	`unregister()` Unregister storage from producer registry.
`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
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

- Field Detail
  - DEF_CATEGORY
```
public static final java.lang.String DEF_CATEGORY
```
    Default category used for producer registration.
    
    See Also:
    
    Constant Field Values
  - DEF_SUBSYSTEM
```
public static final java.lang.String DEF_SUBSYSTEM
```
    Default subsystem used for producer registration.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Storage
```
public Storage(StorageWrapper<K,V> aWrapper)
```
    Creates a new anonymous storage with given wrapper.
    
    Parameters:
    
    aWrapper -
  - Storage
```
public Storage(java.lang.String aName,
               StorageWrapper<K,V> aWrapper)
```
    Creates a new storage with given wrapper.
    
    Parameters:
    
    aName - storage name
    
    aWrapper - wrapper name
- Method Detail
  - 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>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<K,V>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty 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>
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue 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>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<K,V>
  - putAll
```
public void putAll(Storage<? extends K,? extends V> anotherStorage)
```
    Puts all elements from anotherStorage to this storage.
    
    Parameters:
    
    anotherStorage -
  - keySet
```
public java.util.Set<K> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<K,V>
  - keys
```
public java.util.Collection<K> keys()
```
    Convenience method for old hashtable users.
    
    Returns:
    
    the collection of all keys.
  - values
```
public java.util.Collection<V> values()
```
    Specified by:
    
    values in interface java.util.Map<K,V>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<K,V>
  - toMap
```
public java.util.Map<K,V> toMap()
```
    Creates a map copy of this storage with all contained elements.
    
    Returns:
    
    a map containing lal elements from the storage.
  - fillMap
```
public java.util.Map<K,V> fillMap(java.util.Map<K,V> toFill)
```
    Puts all elements into a given map.
    
    Parameters:
    
    toFill - map to fill to.
    
    Returns:
    
    the map.
  - putAll
```
public void putAll(java.util.Map<? extends K,? extends V> anotherMap)
```
    Specified by:
    
    putAll in interface java.util.Map<K,V>
  - getCategory
```
public java.lang.String getCategory()
```
    Description copied from interface: IStatsProducer
    
    Returns the category of this producer. A typical categorie is something like servlet, action, service or dao. The categories are used to group different StatsProducer to get overview over a certain layer in the application, i.e. show me all action.
    
    Specified by:
    
    getCategory in interface IStatsProducer<StorageStats>
    
    Returns:
    
    the id of the category the producer belongs to.
  - getProducerId
```
public java.lang.String getProducerId()
```
    Description copied from interface: IStatsProducer
    
    Returns the meaningful id of this producer. This should be something like a class or interface name.
    
    Specified by:
    
    getProducerId in interface IStatsProducer<StorageStats>
    
    Returns:
    
    a string which provides unique identification of this producer, i.e. the class name or a readable form of it.
  - getStats
```
public java.util.List<StorageStats> getStats()
```
    Description copied from interface: IStatsProducer
    
    Returns the list of all stats.
    
    Specified by:
    
    getStats in interface IStatsProducer<StorageStats>
    
    Returns:
    
    all stats this producer produces / generates.
  - getSubsystem
```
public java.lang.String getSubsystem()
```
    Description copied from interface: IStatsProducer
    
    Returns the subsystem the current producer is located in. Moskito referrs to your application as "the system". If you want to filter some parts of your system separately you should use the getSubsystem() method to separate them. Possible subsystems are: usermanagement, messaging... whatever. The getCategory() method should separate parts of the application horizontally, whether the getSubsystem() method should provide vertical separation.
    
    Specified by:
    
    getSubsystem in interface IStatsProducer<StorageStats>
    
    Returns:
    
    the id of the subsystem the producer belongs to.
  - setSubsystem
```
public void setSubsystem(java.lang.String aSubsystem)
```
    Sets the subsystem of this producer.
    
    Parameters:
    
    aSubsystem - subsystem to set.
  - setCategory
```
public void setCategory(java.lang.String aCategory)
```
    Sets the category of this producer.
    
    Parameters:
    
    aCategory - category to set.
  - getName
```
public java.lang.String getName()
```
    Returns this storage's name.
    
    Returns:
  - getCreationInfo
```
public CreationInfo getCreationInfo()
```
    Description copied from interface: Inspectable
    
    Returns the creation info of this object.
    
    Specified by:
    
    getCreationInfo in interface Inspectable
    
    Returns:
    
    creation info object
  - unregister
```
public void unregister()
```
    Unregister storage from producer registry.
  - createHashMapStorage
```
public static <K,V> Storage<K,V> createHashMapStorage()
```
    Factory method to create a new storage backed by a hashmap.
    
    Type Parameters:
    
    K -
    
    V -
    
    Returns:
  - createHashMapStorage
```
public static <K,V> Storage<K,V> createHashMapStorage(int initialSize)
```
    Factory method to create a new storage backed by a hashmap.
    
    Type Parameters:
    
    K -
    
    V -
    
    Parameters:
    
    initialSize -
    
    Returns:
  - createHashMapStorage
```
public static <K,V> Storage<K,V> createHashMapStorage(java.lang.String name)
```
    Factory method to create a new storage backed by a hashmap.
    
    Type Parameters:
    
    K -
    
    V -
    
    Parameters:
    
    name -
    
    Returns:
  - createHashMapStorage
```
public static <K,V> Storage<K,V> createHashMapStorage(java.lang.String name,
                                                      int initialSize)
```
    Factory method to create a new storage backed by a concurrent hash map.
    
    Type Parameters:
    
    K -
    
    V -
    
    Parameters:
    
    name -
    
    initialSize -
    
    Returns:
  - createConcurrentHashMapStorage
```
public static <K,V> Storage<K,V> createConcurrentHashMapStorage()
```
    Factory method to create a new storage backed by a concurrent hash map.
    
    Type Parameters:
    
    K -
    
    V -
    
    Returns:
  - createConcurrentHashMapStorage
```
public static <K,V> Storage<K,V> createConcurrentHashMapStorage(int initialSize)
```
    Factory method to create a new storage backed by a concurrent hash map.
    
    Type Parameters:
    
    K -
    
    V -
    
    Parameters:
    
    initialSize - initial size of the storage.
    
    Returns:
  - createConcurrentHashMapStorage
```
public static <K,V> Storage<K,V> createConcurrentHashMapStorage(java.lang.String name)
```
    Factory method to create a new storage backed by a concurrent hash map.
    
    Type Parameters:
    
    K -
    
    V -
    
    Parameters:
    
    name -
    
    Returns:
  - createConcurrentHashMapStorage
```
public static <K,V> Storage<K,V> createConcurrentHashMapStorage(java.lang.String name,
                                                                int initialSize)
```
    Factory method to create a new storage backed by a concurrent hash map.
    
    Type Parameters:
    
    K -
    
    V -
    
    Parameters:
    
    name -
    
    initialSize -
    
    Returns:
  - createHashtableStorage
```
public static <K,V> Storage<K,V> createHashtableStorage()
```
    Factory method to create a new storage backed by a hashtable.
    
    Type Parameters:
    
    K -
    
    V -
    
    Returns:
  - createHashtableStorage
```
public static <K,V> Storage<K,V> createHashtableStorage(int initialSize)
```
    Factory method to create a new storage backed by a hashtable.
    
    Type Parameters:
    
    K -
    
    V -
    
    Parameters:
    
    initialSize -
    
    Returns:
  - createHashtableStorage
```
public static <K,V> Storage<K,V> createHashtableStorage(java.lang.String name)
```
    Factory method to create a new storage backed by a hashtable.
    
    Type Parameters:
    
    K -
    
    V -
    
    Parameters:
    
    name -
    
    Returns:
  - createHashtableStorage
```
public static <K,V> Storage<K,V> createHashtableStorage(java.lang.String name,
                                                        int initialSize)
```
    Factory method to create a new storage backed by a hashtable.
    
    Type Parameters:
    
    K -
    
    V -
    
    Parameters:
    
    name -
    
    initialSize -
    
    Returns:
  - createTreeMapStorage
```
public static <K,V> Storage<K,V> createTreeMapStorage(java.lang.String name)
```
    Creates a new TreeMap backed Storage.
    
    Type Parameters:
    
    K -
    
    V -
    
    Parameters:
    
    name - name of the map
    
    Returns:
  - createTreeMapStorage
```
public static <K,V> Storage<K,V> createTreeMapStorage(java.lang.String name,
                                                      java.util.Comparator comparator)
```
    Creates a new TreeMap backed Storage.
    
    Type Parameters:
    
    K -
    
    V -
    
    Parameters:
    
    name - name
    
    comparator - comparator
    
    Returns:

Class Storage<K,V>

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

DEF_CATEGORY

DEF_SUBSYSTEM

Constructor Detail

Storage

Storage

Method Detail

get

put

size

isEmpty

containsKey

containsValue

remove

entrySet

putAll

keySet

keys

values

clear

toMap

fillMap

putAll

getCategory

getProducerId

getStats

getSubsystem

setSubsystem

setCategory

getName

getCreationInfo

unregister

createHashMapStorage

createHashMapStorage

createHashMapStorage

createHashMapStorage

createConcurrentHashMapStorage

createConcurrentHashMapStorage

createConcurrentHashMapStorage

createConcurrentHashMapStorage

createHashtableStorage

createHashtableStorage

createHashtableStorage

createHashtableStorage

createTreeMapStorage

createTreeMapStorage