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 mapV- type of the values in the map
- All Implemented Interfaces:
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
- Implementation Note:
- If methods are added to the interface which this class implements then implementations of those methods must be added to this class.
-
Nested Class Summary
-
Constructor Summary
ConstructorsConstructorDescriptionDecoratingObservableMap(IObservableMap<K, V> decorated, boolean disposeDecoratedOnDispose) Constructs a DecoratingObservableMap which decorates the given observable. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddListener(Object listenerType, IObservablesListener listener) voidaddMapChangeListener(IMapChangeListener<? super K, ? super V> listener) voidclear()protected Objectclone()booleancontainsKey(Object key) booleancontainsValue(Object value) voiddispose()Disposes of this observable object, removing all listeners registered with this object, and all listeners this object might have registered on other objects.entrySet()booleanprotected voidprotected voidfireEvent(ObservableEvent event) protected voidfireMapChange(MapDiff<K, V> diff) protected voidReturns the element type for thekeysetof this observable map, ornullif the keyset is untyped.getRealm()Returns the element type for thevaluesof this observable map, ornullif the values collection is untyped.protected voidhandleMapChange(MapChangeEvent<? extends K, ? extends V> event) Called whenever a MapChangeEvent is received from the decorated observable.inthashCode()protected booleanbooleanisEmpty()keySet()protected voidvoidprotected voidremoveListener(Object listenerType, IObservablesListener listener) voidremoveMapChangeListener(IMapChangeListener<? super K, ? super V> listener) intsize()toString()values()Methods inherited from class org.eclipse.core.databinding.observable.DecoratingObservable
getDecorated, getterCalled, handleStaleEvent, isStaleMethods inherited from class org.eclipse.core.databinding.observable.AbstractObservable
addChangeListener, addDisposeListener, addStaleListener, checkRealm, fireStale, isDisposed, removeChangeListener, removeDisposeListener, removeStaleListenerMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.eclipse.core.databinding.observable.IObservable
addChangeListener, addDisposeListener, addStaleListener, getRealm, isDisposed, isStale, removeChangeListener, removeDisposeListener, removeStaleListenerMethods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Constructor Details
-
DecoratingObservableMap
Constructs a DecoratingObservableMap which decorates the given observable.- Parameters:
decorated- the observable map being decorateddisposeDecoratedOnDispose- whether the decorated observable should be disposed when the decorator is disposed
-
-
Method Details
-
addMapChangeListener
- Specified by:
addMapChangeListenerin interfaceIObservableMap<K,V> - Parameters:
listener- the change listener to add; notnull
-
removeMapChangeListener
- Specified by:
removeMapChangeListenerin interfaceIObservableMap<K,V> - Parameters:
listener- the change listener to remove; notnull
-
getKeyType
Description copied from interface:IObservableMapReturns the element type for thekeysetof this observable map, ornullif the keyset is untyped.- Specified by:
getKeyTypein interfaceIObservableMap<K,V> - Returns:
- the element type for the
keysetof this observable map, ornullif the keyset is untyped.
-
getValueType
Description copied from interface:IObservableMapReturns the element type for thevaluesof this observable map, ornullif the values collection is untyped.- Specified by:
getValueTypein interfaceIObservableMap<K,V> - Returns:
- the element type for the
valuesof this observable map, ornullif the values collection is untyped.
-
fireMapChange
-
fireChange
protected void fireChange()- Overrides:
fireChangein classAbstractObservable
-
firstListenerAdded
protected void firstListenerAdded()- Overrides:
firstListenerAddedin classDecoratingObservable
-
lastListenerRemoved
protected void lastListenerRemoved()- Overrides:
lastListenerRemovedin classDecoratingObservable
-
handleMapChange
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() -
containsKey
- Specified by:
containsKeyin interfaceIObservableMap<K,V> - Specified by:
containsKeyin interfaceMap<K,V>
-
containsValue
- Specified by:
containsValuein interfaceIObservableMap<K,V> - Specified by:
containsValuein interfaceMap<K,V>
-
entrySet
-
get
-
isEmpty
public boolean isEmpty() -
keySet
-
put
-
putAll
-
remove
-
size
public int size() -
values
-
equals
- Specified by:
equalsin interfaceIObservableMap<K,V> - Specified by:
equalsin interfaceMap<K,V> - Overrides:
equalsin classDecoratingObservable
-
hashCode
public int hashCode()- Specified by:
hashCodein interfaceIObservableMap<K,V> - Specified by:
hashCodein interfaceMap<K,V> - Overrides:
hashCodein classDecoratingObservable
-
toString
-
dispose
public void dispose()Description copied from interface:IObservableDisposes of this observable object, removing all listeners registered with this object, and all listeners this object might have registered on other objects.- Specified by:
disposein interfaceIObservable- Overrides:
disposein classDecoratingObservable
-
addListener
- Parameters:
listenerType- arbitrary object to identify a type of the listenerlistener- the listener to add; notnull
-
removeListener
- Parameters:
listenerType- arbitrary object to identify a type of the listenerlistener- the listener to remove; notnull
-
hasListeners
protected boolean hasListeners() -
fireEvent
-
getRealm
- Returns:
- Returns the realm.
-
clone
- Overrides:
clonein classObject- Throws:
CloneNotSupportedException
-