Package org.checkerframework.afu.scenelib.util.coll

Class WrapperMap<K,V>

java.lang.Object

org.checkerframework.afu.scenelib.util.coll.WrapperMap<K,V>

Type Parameters:

K - the type of keys for the map

V - the type of values for the map

All Implemented Interfaces:

Map<K,V>

Direct Known Subclasses:

ASTIndex, VivifyingMap

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

A WrapperMap is a map all of whose methods delegate by default to those of a supplied backing map. Subclasses can add or override methods. Compare to FilterInputStream.

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final @Modifiable Map<K,V>	back	The backing map.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WrapperMap(@Modifiable Map<K,V> back)	Constructs a new WrapperMap with the given backing map.

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
@IteratorPolyMod @PolyShrinkable @Ungrowable Set<@PolyModifiable Map.Entry<K,V>>	entrySet()
boolean	equals(Object o)
V	get(Object key)
int	hashCode()
boolean	isEmpty()
@IteratorPolyMod @PolyShrinkable @Ungrowable Set<K>	keySet()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
V	remove(Object key)
int	size()
String	toString()
@IteratorPolyMod @PolyShrinkable @Ungrowable Collection<V>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Field Details

back

protected final @Modifiable Map<K,V> back

The backing map.

Constructor Details

WrapperMap

protected WrapperMap(@Modifiable Map<K,V> back)

Constructs a new WrapperMap with the given backing map.

Parameters:

back - the backing map

Method Details

clear

@SideEffectsOnly("this")
public void clear(@Shrinkable WrapperMap<K,V> this)

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 @IteratorPolyMod @PolyShrinkable @Ungrowable Set<@PolyModifiable Map.Entry<K,V>> entrySet(@PolyModifiable WrapperMap<K,V> this)

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>

keySet

public @IteratorPolyMod @PolyShrinkable @Ungrowable Set<K> keySet(@PolyShrinkable WrapperMap<K,V> this)

Specified by:

keySet in interface Map<K,V>

put

@SideEffectsOnly("this")
public V put(@Growable @Replaceable WrapperMap<K,V> this,
 K key,
 V value)

Specified by:

put in interface Map<K,V>

putAll

@SideEffectsOnly("this")
public void putAll(@Growable @Replaceable WrapperMap<K,V> this,
 Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

remove

@SideEffectsOnly("this")
public V remove(@Shrinkable WrapperMap<K,V> this,
 Object key)

Specified by:

remove in interface Map<K,V>

size

public int size()

Specified by:

size in interface Map<K,V>

values

public @IteratorPolyMod @PolyShrinkable @Ungrowable Collection<V> values(@PolyShrinkable WrapperMap<K,V> this)

Specified by:

values in interface Map<K,V>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object