org.kocakosm.pitaya.collection

Class ChainMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

org.kocakosm.pitaya.collection.ChainMap<K,V>

Type Parameters:

K - the type of the Map's keys.

V - the type of the Map's values.

All Implemented Interfaces:

Map<K,V>

public final class ChainMap<K,V>
extends AbstractMap<K,V>

A ChainMap is a Map implementation that groups multiple Maps together. Lookups sequentially walk trough all the underlying Maps until the value for the looked up key is found. Writes and updates only modify the first Map. Deletions are applied on all underlying Maps. Note that only references to the input Maps are stored, so, if one of these Maps gets updated, those changes will also be reflected in the ChainMap. Not thread safe.

Author:

Osman KOCAK

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ChainMap(Iterable<? extends Map<K,V>> maps) Creates a new ChainMap from the given Maps.
ChainMap(Map<K,V>... maps) Creates a new ChainMap from the given Maps.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,V>>	entrySet()
V	get(Object key)
boolean	isEmpty()
Set<K>	keySet()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
V	remove(Object key)
int	size()
Collection<V>	values()

Methods inherited from class java.util.AbstractMap

clone, equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChainMap

public ChainMap(Map<K,V>... maps)

Creates a new ChainMap from the given Maps.

Parameters:

maps - the input Maps.

Throws:

NullPointerException - if maps is null or if it contains a null reference.

IllegalArgumentException - if maps is empty.

ChainMap

public ChainMap(Iterable<? extends Map<K,V>> maps)

Creates a new ChainMap from the given Maps.

Parameters:

maps - the input Maps.

Throws:

NullPointerException - if maps is null or if it contains a null reference.

IllegalArgumentException - if maps is empty.

Method Detail

size

public int size()

Specified by:

size in interface Map<K,V>

Overrides:

size in class AbstractMap<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

Overrides:

isEmpty in class AbstractMap<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

Overrides:

containsKey in class AbstractMap<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

Overrides:

containsValue in class AbstractMap<K,V>

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

Overrides:

get in class AbstractMap<K,V>

put

public V put(K key,
    V value)

Specified by:

put in interface Map<K,V>

Overrides:

put in class AbstractMap<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class AbstractMap<K,V>

putAll

public void putAll(Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class AbstractMap<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractMap<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

Overrides:

keySet in class AbstractMap<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

Overrides:

values in class AbstractMap<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in class AbstractMap<K,V>