org.eclipse.core.databinding.observable.map

Class DecoratingObservableMap<K,V>

java.lang.Object

org.eclipse.core.databinding.observable.AbstractObservable

org.eclipse.core.databinding.observable.DecoratingObservable

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

Type Parameters:

K - type of the keys to the map

V - type of the values in the map

All Implemented Interfaces:

java.util.Map<K,V>, IDecoratingObservable, IObservable, IObservableMap<K,V>

Direct Known Subclasses:

BidiObservableMap

public class DecoratingObservableMap<K,V>
extends DecoratingObservable
implements IObservableMap<K,V>

An observable map which decorates another observable map.

Since:

1.2

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
DecoratingObservableMap(IObservableMap<K,V> decorated, boolean disposeDecoratedOnDispose) Constructs a DecoratingObservableMap which decorates the given observable.

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 obj)
protected void	fireChange()
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()
java.lang.Object	getValueType() Returns the element type for the values of this observable map, or null if the values collection is untyped.
protected void	handleMapChange(MapChangeEvent<? extends K,? extends V> event) Called whenever a MapChangeEvent is received from the decorated observable.
int	hashCode()
protected boolean	hasListeners()
boolean	isEmpty()
java.util.Set<K>	keySet()
protected void	lastListenerRemoved()
V	put(K key, V value)
void	putAll(java.util.Map<? extends K,? extends V> m)
V	remove(java.lang.Object key)
protected void	removeListener(java.lang.Object listenerType, IObservablesListener listener)
void	removeMapChangeListener(IMapChangeListener<? super K,? super V> listener)
int	size()
java.lang.String	toString()
java.util.Collection<V>	values()

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

getDecorated, getterCalled, handleStaleEvent, isStale

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

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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

DecoratingObservableMap

public DecoratingObservableMap(IObservableMap<K,V> decorated,
                               boolean disposeDecoratedOnDispose)

Constructs a DecoratingObservableMap which decorates the given observable.

Parameters:

decorated - the observable map being decorated

disposeDecoratedOnDispose -

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.

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.

fireMapChange

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

fireChange

protected void fireChange()

Overrides:

fireChange in class AbstractObservable

firstListenerAdded

protected void firstListenerAdded()

Overrides:

firstListenerAdded in class DecoratingObservable

lastListenerRemoved

protected void lastListenerRemoved()

Overrides:

lastListenerRemoved in class DecoratingObservable

handleMapChange

protected void handleMapChange(MapChangeEvent<? extends K,? extends V> event)

Called whenever a MapChangeEvent is received from the decorated observable. By default, this method fires the map change event again, with the decorating observable as the event source. Subclasses may override to provide different behavior.

Parameters:

event - the change event received from the decorated observable

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>

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>

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>

putAll

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

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>

Specified by:

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

equals

public boolean equals(java.lang.Object obj)

Specified by:

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

Specified by:

equals in interface IObservableMap<K,V>

Overrides:

equals in class DecoratingObservable

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 DecoratingObservable

toString

public java.lang.String toString()

Overrides:

toString 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 DecoratingObservable

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)

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