org.eclipse.core.databinding.observable.map

Class MapDiff<K,V>

java.lang.Object

org.eclipse.core.databinding.observable.map.MapDiff<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Implemented Interfaces:

IDiff

public abstract class MapDiff<K,V>
extends java.lang.Object
implements IDiff

Since:

1.1

Constructor Summary

Constructors

Constructor and Description
MapDiff()

Method Summary

Modifier and Type	Method and Description
void	applyTo(java.util.Map<? super K,? super V> map) Applies the changes in this diff to the given map
abstract java.util.Set<K>	getAddedKeys()
abstract java.util.Set<K>	getChangedKeys()
abstract V	getNewValue(java.lang.Object key) Returns the new value for the given key, which must be an element of getChangedKeys() or getAddedKeys().
abstract V	getOldValue(java.lang.Object key) Returns the old value for the given key, which must be an element of getRemovedKeys() or getChangedKeys().
abstract java.util.Set<K>	getRemovedKeys()
boolean	isEmpty() Returns true if the diff has no added, removed or changed entries.
java.util.Map<K,V>	simulateOn(java.util.Map<K,V> map) Returns a map showing what map would look like if this diff were applied to it.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapDiff

public MapDiff()

Method Detail

isEmpty

public boolean isEmpty()

Returns true if the diff has no added, removed or changed entries.

Returns:

true if the diff has no added, removed or changed entries.

Since:

1.2

applyTo

public void applyTo(java.util.Map<? super K,? super V> map)

Applies the changes in this diff to the given map

Parameters:

map - the map to which the diff will be applied

Since:

1.2

simulateOn

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

Returns a map showing what map would look like if this diff were applied to it.

Note: the returned map is only valid until structural changes are made to the passed-in map.

Parameters:

map - the map over which the diff will be simulated

Returns:

an unmodifiable map showing what map would look like if it were passed to the applyTo(Map) method.

Since:

1.3

See Also:

applyTo(Map)

getAddedKeys

public abstract java.util.Set<K> getAddedKeys()

Returns:

the set of keys which were added

getRemovedKeys

public abstract java.util.Set<K> getRemovedKeys()

Returns:

the set of keys which were removed

getChangedKeys

public abstract java.util.Set<K> getChangedKeys()

Returns:

the set of keys for which the value has changed

getOldValue

public abstract V getOldValue(java.lang.Object key)

Returns the old value for the given key, which must be an element of getRemovedKeys() or getChangedKeys().

Parameters:

key -

Returns:

the old value for the given key.

getNewValue

public abstract V getNewValue(java.lang.Object key)

Returns the new value for the given key, which must be an element of getChangedKeys() or getAddedKeys().

Parameters:

key -

Returns:

the new value for the given key.