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:

java.util.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

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ObservableMap(java.util.Map<K,V> wrappedMap)
ObservableMap(Realm realm, java.util.Map<K,V> wrappedMap)

Method Summary

Modifier and Type	Method and Description
protected void	addListener(java.lang.Object listenerType, IObservablesListener listener)
void	addMapChangeListener(IMapChangeListener<? super K,? super V> listener)
void	clear()
protected java.lang.Object	clone()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
void	dispose() Disposes of this observable object, removing all listeners registered with this object, and all listeners this object might have registered on other objects.
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
boolean	equals(java.lang.Object o)
protected void	fireEvent(ObservableEvent event)
protected void	fireMapChange(MapDiff<K,V> diff)
protected void	firstListenerAdded()
V	get(java.lang.Object key)
java.lang.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()
java.lang.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.
java.util.Set<K>	keySet()
protected void	lastListenerRemoved()
V	put(K key, V value)
void	putAll(java.util.Map<? extends K,? extends V> arg0)
V	remove(java.lang.Object key)
protected void	removeListener(java.lang.Object listenerType, IObservablesListener listener)
void	removeMapChangeListener(IMapChangeListener<? super K,? super V> listener)
void	setStale(boolean stale) Sets the stale state.
int	size()
java.util.Collection<V>	values()

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

addChangeListener, addDisposeListener, addStaleListener, checkRealm, 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 java.util.Map

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

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

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

Field Detail

wrappedMap

protected java.util.Map<K,V> wrappedMap

Constructor Detail

ObservableMap

public ObservableMap(java.util.Map<K,V> wrappedMap)

Parameters:

wrappedMap -

ObservableMap

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

Parameters:

realm -

wrappedMap -

Method Detail

addMapChangeListener

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

Specified by:

addMapChangeListener in interface IObservableMap<K,V>

removeMapChangeListener

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

Specified by:

removeMapChangeListener in interface IObservableMap<K,V>

getKeyType

public java.lang.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 java.lang.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(java.lang.Object key)

Specified by:

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

Specified by:

containsKey in interface IObservableMap<K,V>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

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

Specified by:

containsValue in interface IObservableMap<K,V>

entrySet

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

Specified by:

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

Specified by:

entrySet in interface IObservableMap<K,V>

get

public V get(java.lang.Object key)

Specified by:

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

Specified by:

get in interface IObservableMap<K,V>

isEmpty

public boolean isEmpty()

Specified by:

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

Specified by:

isEmpty in interface IObservableMap<K,V>

keySet

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

Specified by:

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

Specified by:

keySet in interface IObservableMap<K,V>

size

public int size()

Specified by:

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

Specified by:

size in interface IObservableMap<K,V>

values

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

Specified by:

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

Specified by:

values in interface IObservableMap<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 java.util.Map<K,V>

Specified by:

put in interface IObservableMap<K,V>

remove

public V remove(java.lang.Object key)

Specified by:

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

Specified by:

remove in interface IObservableMap<K,V>

clear

public void clear()

Specified by:

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

putAll

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

Specified by:

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

equals

public boolean equals(java.lang.Object o)

Specified by:

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

Specified by:

equals in interface IObservableMap<K,V>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

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

Specified by:

hashCode in interface IObservableMap<K,V>

Overrides:

hashCode in class java.lang.Object

dispose

public void dispose()

Description copied from interface: IObservable

Disposes of this observable object, removing all listeners registered with this object, and all listeners this object might have registered on other objects.

Specified by:

dispose in interface IObservable

Overrides:

dispose in class AbstractObservable

addListener

protected void addListener(java.lang.Object listenerType,
                           IObservablesListener listener)

Parameters:

listenerType -

listener -

removeListener

protected void removeListener(java.lang.Object listenerType,
                              IObservablesListener listener)

Parameters:

listenerType -

listener -

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 java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException