jpaul.DataStructs
Class MapWrapper<K,V>

java.lang.Object
  jpaul.DataStructs.MapWrapper<K,V>

All Implemented Interfaces:

java.util.Map<K,V>

Direct Known Subclasses:

BijMap, MapWithDefault

public abstract class MapWrapper<K,V>
extends java.lang.Object
implements java.util.Map<K,V>

MapWrapper is a map backed by another map. All operations on this map are forwarded to the underlying map. Subclassing this class makes it easier to write map wrappers that change the behaviour of only a few Map methods.

Version:

$Id: MapWrapper.java,v 1.5 2006/03/14 02:29:31 salcianu Exp $

Author:

Alexandru Salcianu - salcianu@alum.mit.edu

Nested Class Summary

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

java.util.Map.Entry<K,V>

Field Summary

protected java.util.Map<K,V>

map Underlying map.

Constructor Summary

MapWrapper(java.util.Map<K,V> map)
Creates a MapWrapper.

Method Summary

void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
boolean	equals(java.lang.Object obj)
V	get(java.lang.Object key)
int	hashCode()
boolean	isEmpty()
java.util.Set<K>	keySet()
V	put(K key, V value)
void	putAll(java.util.Map<? extends K,? extends V> t)
V	remove(java.lang.Object key)
int	size()
java.util.Collection<V>	values()

Methods inherited from class java.lang.Object

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

Field Detail

map

protected final java.util.Map<K,V> map

Underlying map.

Constructor Detail

MapWrapper

public MapWrapper(java.util.Map<K,V> map)

Creates a MapWrapper.

Parameters:

map - The underlying, real map

Method Detail

clear

public void clear()

Specified by:

clear 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>

entrySet

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

Specified by:

entrySet in interface java.util.Map<K,V>

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Map<K,V>

Overrides:

equals in class java.lang.Object

get

public V get(java.lang.Object key)

Specified by:

get in interface java.util.Map<K,V>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<K,V>

Overrides:

hashCode in class java.lang.Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<K,V>

keySet

public java.util.Set<K> keySet()

Specified by:

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

putAll

public void putAll(java.util.Map<? extends K,? extends V> t)

Specified by:

putAll 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>

size

public int size()

Specified by:

size in interface java.util.Map<K,V>

values

public java.util.Collection<V> values()

Specified by:

values in interface java.util.Map<K,V>