org.everit.templating.util

Class InheritantMap<K,V>

java.lang.Object

org.everit.templating.util.InheritantMap<K,V>

Type Parameters:

K - Type of key of the map.

V - Type of value of the map.

All Implemented Interfaces:

Map<K,V>

public class InheritantMap<K,V>
extends Object
implements Map<K,V>

A Map implementation that allows to return values from a parent map in the way that modifications are only applied to the current instance.

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
InheritantMap(Map<K,V> parentMap, boolean updateOnParent) Constructor that uses a HashMap as a child Map.
InheritantMap(Map<K,V> parentMap, Map<K,V> childMap, boolean updateOnParent) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object obj)
V	get(Object key)
int	hashCode()
boolean	isEmpty()
Set<K>	keySet()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
V	putWithoutChecks(K key, V value) Same as put(Object, Object) but without checking reserved words.
V	remove(Object key)
int	size()
Collection<V>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

InheritantMap

public InheritantMap(Map<K,V> parentMap,
                     boolean updateOnParent)

Constructor that uses a HashMap as a child Map.

Parameters:

parentMap - The map that holds key-value pairs that are accessible, but not modifiable via this map instance.

updateOnParent - In case of true, those keys will be updated on the parent that were already available there, otherwise every operation will be processed on the child map.

InheritantMap

public InheritantMap(Map<K,V> parentMap,
                     Map<K,V> childMap,
                     boolean updateOnParent)

Constructor.

Parameters:

parentMap - The map that holds key-value pairs that are accessible, but not modifiable via this map instance.

childMap - The child map that is read first or updated directly.

updateOnParent - In case of true, those keys will be updated on the parent that were already available there, otherwise every operation will be processed on the child map.

Method Detail

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>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet 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> m)

Specified by:

putAll in interface Map<K,V>

putWithoutChecks

public V putWithoutChecks(K key,
                          V value)

Same as put(Object, Object) but without checking reserved words.

Parameters:

key - The key.

value - The value.

Returns:

The previous value if existed.

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>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>