MultiLevelMap (Auderis Tools - core utilities 0.0.1 API)

java.lang.Object
- cz.auderis.tools.collection.MultiLevelMap<K,V>

Type Parameters:

K - the type parameter

V - the type parameter

All Implemented Interfaces:

CascadingMap<K,V>, Map<K,V>
```
public class MultiLevelMap<K,V>
extends Object
implements CascadingMap<K,V>
```
The type Multi level map.

Version:

1.0

Author:

Boleslav Bobcik <bbobcik@gmail.com>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`MultiLevelMap.EntryIterator` The type Entry iterator.
`protected class`	`MultiLevelMap.KeyIterator` The type Key iterator.
`protected class`	`MultiLevelMap.MultiLevelEntrySet` The type Multi level entry set.
`protected class`	`MultiLevelMap.MultiLevelKeySet` The type Multi level key set.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<K,V>`	`currentLevel` The Current level.
`protected MultiLevelMap.MultiLevelEntrySet`	`entrySetView` The Entry set view.
`protected static String`	`ERR_ITEMS_NOT_ENTRIES` The constant ERR_ITEMS_NOT_ENTRIES.
`protected MultiLevelMap.MultiLevelKeySet`	`keySetView` The Key set view.
`protected Map<K,V>`	`parent` The Parent.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`MultiLevelMap(Map<? extends K,? extends V> current, Map<? extends K,? extends V> parent)` Instantiates a new Multi level map.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`void`	`clearCurrentMap()` Clear current map.
`void`	`clearParentMap()` Clear parent map.
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`static <K1,V1> MultiLevelMap<K1,V1>`	`create()` Create multi level map.
`static <K1,V1> MultiLevelMap<K1,V1>`	`createWithContentAndParent(Map<? extends K1,? extends V1> content, Map<? extends K1,? extends V1> parentMap)` Create with content and parent.
`static <K1,V1> MultiLevelMap<K1,V1>`	`createWithParent(Map<? extends K1,? extends V1> parentMap)` Create with parent.
`Set<Map.Entry<K,V>>`	`entrySet()`
`V`	`get(Object key)`
`Map<K,V>`	`getParentMap()` Gets parent map.
`boolean`	`hasParentMap()` Has parent map.
`boolean`	`isEmpty()`
`Set<K>`	`keySet()`
`V`	`put(K key, V value)`
`void`	`putAll(Map<? extends K,? extends V> otherMap)`
`V`	`remove(Object key)`
`V`	`removeFromCurrentMap(Object key)` Remove from current map.
`void`	`setParentMap(Map<? extends K,? extends V> prnt)` Sets parent map.
`int`	`size()`
`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
  - ERR_ITEMS_NOT_ENTRIES
```
protected static final String ERR_ITEMS_NOT_ENTRIES
```
    The constant ERR_ITEMS_NOT_ENTRIES.
    
    See Also:
    
    Constant Field Values
  - currentLevel
```
protected final Map<K,V> currentLevel
```
    The Current level.
  - entrySetView
```
protected final transient MultiLevelMap.MultiLevelEntrySet entrySetView
```
    The Entry set view.
  - keySetView
```
protected final transient MultiLevelMap.MultiLevelKeySet keySetView
```
    The Key set view.
  - parent
```
protected Map<K,V> parent
```
    The Parent.
- Constructor Detail
  - MultiLevelMap
```
protected MultiLevelMap(Map<? extends K,? extends V> current,
                        Map<? extends K,? extends V> parent)
```
    Instantiates a new Multi level map.
    
    Parameters:
    
    current - the current
    
    parent - the parent
- Method Detail
  - create
```
public static <K1,V1> MultiLevelMap<K1,V1> create()
```
    Create multi level map.
    
    Type Parameters:
    
    K1 - the type parameter
    
    V1 - the type parameter
    
    Returns:
    
    the multi level map
  - createWithParent
```
public static <K1,V1> MultiLevelMap<K1,V1> createWithParent(Map<? extends K1,? extends V1> parentMap)
```
    Create with parent.
    
    Type Parameters:
    
    K1 - the type parameter
    
    V1 - the type parameter
    
    Parameters:
    
    parentMap - the parent map
    
    Returns:
    
    the multi level map
  - createWithContentAndParent
```
public static <K1,V1> MultiLevelMap<K1,V1> createWithContentAndParent(Map<? extends K1,? extends V1> content,
                                                                      Map<? extends K1,? extends V1> parentMap)
```
    Create with content and parent.
    
    Type Parameters:
    
    K1 - the type parameter
    
    V1 - the type parameter
    
    Parameters:
    
    content - the content
    
    parentMap - the parent map
    
    Returns:
    
    the multi level map
  - getParentMap
```
public Map<K,V> getParentMap()
```
    Description copied from interface: CascadingMap
    
    Gets parent map.
    
    Specified by:
    
    getParentMap in interface CascadingMap<K,V>
    
    Returns:
    
    the parent map
  - setParentMap
```
public void setParentMap(Map<? extends K,? extends V> prnt)
```
    Description copied from interface: CascadingMap
    
    Sets parent map.
    
    Specified by:
    
    setParentMap in interface CascadingMap<K,V>
    
    Parameters:
    
    prnt - the parent map
  - hasParentMap
```
public boolean hasParentMap()
```
    Description copied from interface: CascadingMap
    
    Has parent map.
    
    Specified by:
    
    hasParentMap in interface CascadingMap<K,V>
    
    Returns:
    
    the boolean
  - clearCurrentMap
```
public void clearCurrentMap()
```
    Description copied from interface: CascadingMap
    
    Clear current map.
    
    Specified by:
    
    clearCurrentMap in interface CascadingMap<K,V>
  - clearParentMap
```
public void clearParentMap()
```
    Description copied from interface: CascadingMap
    
    Clear parent map.
    
    Specified by:
    
    clearParentMap in interface CascadingMap<K,V>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<K,V>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<K,V>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<K,V>
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<K,V>
  - get
```
public V get(Object key)
```
    Specified by:
    
    get in interface Map<K,V>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<K,V>
  - put
```
public V put(K key,
             V value)
```
    Specified by:
    
    put in interface Map<K,V>
  - putAll
```
public void putAll(Map<? extends K,? extends V> otherMap)
```
    Specified by:
    
    putAll in interface Map<K,V>
  - removeFromCurrentMap
```
public V removeFromCurrentMap(Object key)
```
    Description copied from interface: CascadingMap
    
    Remove from current map.
    
    Specified by:
    
    removeFromCurrentMap in interface CascadingMap<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the v
  - remove
```
public V remove(Object key)
```
    Specified by:
    
    remove in interface Map<K,V>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<K,V>
  - keySet
```
public Set<K> keySet()
```
    Specified by:
    
    keySet in interface Map<K,V>
  - values
```
public Collection<V> values()
```
    Specified by:
    
    values in interface Map<K,V>

Class MultiLevelMap<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

ERR_ITEMS_NOT_ENTRIES

currentLevel

entrySetView

keySetView

parent

Constructor Detail

MultiLevelMap

Method Detail

create

createWithParent

createWithContentAndParent

getParentMap

setParentMap

hasParentMap

clearCurrentMap

clearParentMap

clear

containsKey

containsValue

entrySet

get

isEmpty

put

putAll

removeFromCurrentMap

remove

size

keySet

values