Package org.eclipse.core.databinding.observable.map

Class ObservableMap<K,V>

java.lang.Object

org.eclipse.core.databinding.observable.AbstractObservable

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

Type Parameters:

K - the type of the keys in this map

V - the type of the values in this map

All Implemented Interfaces:

Map<K,V>, IObservable, IObservableMap<K,V>

Direct Known Subclasses:

BidirectionalMap, CompositeMap, WritableMap

public class ObservableMap<K,V>
extends AbstractObservable
implements IObservableMap<K,V>

This class is thread safe. All state accessing methods must be invoked from the current realm. Methods for adding and removing listeners may be invoked from any thread.

Since:

1.0

Nested Class Summary

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

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<K,V>	wrappedMap

Constructor Summary

Constructors

Constructor	Description
ObservableMap(Map<K,V> wrappedMap)
ObservableMap(Realm realm, Map<K,V> wrappedMap)

Method Summary

Modifier and Type	Method	Description
protected void	addListener(Object listenerType, IObservablesListener listener)
void	addMapChangeListener(IMapChangeListener<? super K,? super V> listener)
void	clear()
protected Object	clone()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object o)
protected void	fireEvent(ObservableEvent event)
protected void	fireMapChange(MapDiff<K,V> diff)
protected void	firstListenerAdded()
V	get(Object key)
Object	getKeyType()	Returns the element type for the keyset of this observable map, or null if the keyset is untyped.
Realm	getRealm()
protected void	getterCalled()
Object	getValueType()	Returns the element type for the values of this observable map, or null if the values collection is untyped.
int	hashCode()
protected boolean	hasListeners()
boolean	isEmpty()
boolean	isStale()	Returns the stale state.
Set<K>	keySet()
protected void	lastListenerRemoved()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> arg0)
V	remove(Object key)
protected void	removeListener(Object listenerType, IObservablesListener listener)
void	removeMapChangeListener(IMapChangeListener<? super K,? super V> listener)
void	setStale(boolean stale)	Sets the stale state.
int	size()
Collection<V>	values()

Methods inherited from class org.eclipse.core.databinding.observable.AbstractObservable

addChangeListener, addDisposeListener, addStaleListener, checkRealm, dispose, fireChange, fireStale, isDisposed, removeChangeListener, removeDisposeListener, removeStaleListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.core.databinding.observable.IObservable

addChangeListener, addDisposeListener, addStaleListener, dispose, getRealm, isDisposed, removeChangeListener, removeDisposeListener, removeStaleListener

Methods inherited from interface java.util.Map

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

Field Details

wrappedMap

protected Map<K,V> wrappedMap

Constructor Details

ObservableMap

public ObservableMap(Map<K,V> wrappedMap)

Parameters:

wrappedMap - backing store for the map data, used to implement all map operations

ObservableMap

public ObservableMap(Realm realm,
 Map<K,V> wrappedMap)

Parameters:

realm - the realm to use; not null

wrappedMap - backing store for the map data, used to implement all map operations

Method Details

addMapChangeListener

public void addMapChangeListener(IMapChangeListener<? super K,? super V> listener)

Specified by:

addMapChangeListener in interface IObservableMap<K,V>

Parameters:

listener - the change listener to add; not null

removeMapChangeListener

public void removeMapChangeListener(IMapChangeListener<? super K,? super V> listener)

Specified by:

removeMapChangeListener in interface IObservableMap<K,V>

Parameters:

listener - the change listener to remove; not null

getKeyType

public Object getKeyType()

Description copied from interface: IObservableMap

Returns the element type for the keyset of this observable map, or null if the keyset is untyped.

Specified by:

getKeyType in interface IObservableMap<K,V>

Returns:

the element type for the keyset of this observable map, or null if the keyset is untyped.

Since:

1.2

getValueType

public Object getValueType()

Description copied from interface: IObservableMap

Returns the element type for the values of this observable map, or null if the values collection is untyped.

Specified by:

getValueType in interface IObservableMap<K,V>

Returns:

the element type for the values of this observable map, or null if the values collection is untyped.

Since:

1.2

getterCalled

protected void getterCalled()

fireMapChange

protected void fireMapChange(MapDiff<K,V> diff)

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface IObservableMap<K,V>

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface IObservableMap<K,V>

Specified by:

containsValue in interface Map<K,V>

entrySet

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

Specified by:

entrySet in interface IObservableMap<K,V>

Specified by:

entrySet in interface Map<K,V>

get

public V get(Object key)

Specified by:

get in interface IObservableMap<K,V>

Specified by:

get in interface Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IObservableMap<K,V>

Specified by:

isEmpty in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface IObservableMap<K,V>

Specified by:

keySet in interface Map<K,V>

size

public int size()

Specified by:

size in interface IObservableMap<K,V>

Specified by:

size in interface Map<K,V>

values

public Collection<V> values()

Specified by:

values in interface IObservableMap<K,V>

Specified by:

values in interface Map<K,V>

isStale

public boolean isStale()

Returns the stale state. Must be invoked from the current realm.

Specified by:

isStale in interface IObservable

Returns:

stale state

setStale

public void setStale(boolean stale)

Sets the stale state. Must be invoked from the current realm.

Parameters:

stale - The stale state to set. This will fire a stale event if the given boolean is true and this observable set was not already stale.

put

public V put(K key,
 V value)

Specified by:

put in interface IObservableMap<K,V>

Specified by:

put in interface Map<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface IObservableMap<K,V>

Specified by:

remove in interface Map<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

putAll

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

Specified by:

putAll in interface Map<K,V>

equals

public boolean equals(Object o)

Specified by:

equals in interface IObservableMap<K,V>

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface IObservableMap<K,V>

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

addListener

protected void addListener(Object listenerType,
 IObservablesListener listener)

Parameters:

listenerType - arbitrary object to identify a type of the listener

listener - the listener to add; not null

removeListener

protected void removeListener(Object listenerType,
 IObservablesListener listener)

Parameters:

listenerType - arbitrary object to identify a type of the listener

listener - the listener to remove; not null

hasListeners

protected boolean hasListeners()

fireEvent

protected void fireEvent(ObservableEvent event)

firstListenerAdded

protected void firstListenerAdded()

lastListenerRemoved

protected void lastListenerRemoved()

getRealm

public Realm getRealm()

Returns:

Returns the realm.

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException