Eclipse Plug-in Developer Guide (Galileo) - DecoratingObservableMap (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.core.databinding.observable.map
Class DecoratingObservableMap


java.lang.Object
  

org.eclipse.core.databinding.observable.AbstractObservable
      

org.eclipse.core.databinding.observable.DecoratingObservable
          
org.eclipse.core.databinding.observable.map.DecoratingObservableMap

All Implemented Interfaces:: Map, IDecoratingObservable, IObservable, IObservableMap

Direct Known Subclasses:: BidiObservableMap

public class DecoratingObservableMap
extends DecoratingObservable
implements IObservableMap
extends DecoratingObservable
implements IObservableMap

An observable map which decorates another observable map.

Since:: 1.2

Nested Class Summary

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

Map.Entry< K, V>

Constructor Summary

DecoratingObservableMap ( IObservableMap decorated, boolean disposeDecoratedOnDispose)
          Constructs a DecoratingObservableMap which decorates the given observable.

Method Summary

protected void addListener ( Object listenerType, IObservablesListener listener)


void addMapChangeListener ( IMapChangeListener listener)


void clear ()


protected Object clone ()


boolean containsKey ( Object key)


boolean containsValue ( 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.

Set entrySet ()


boolean equals ( Object o)


protected void fireChange ()


protected void fireEvent ( ObservableEvent event)


protected void fireMapChange ( MapDiff diff)


protected void firstListenerAdded ()


Object 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 ()


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 event)
          Called whenever a MapChangeEvent is received from the decorated observable.

int hashCode ()


protected boolean hasListeners ()


boolean isEmpty ()


Set keySet ()


protected void lastListenerRemoved ()


Object put ( Object key, Object value)


void putAll ( Map m)


Object remove ( Object key)


protected void removeListener ( Object listenerType, IObservablesListener listener)


void removeMapChangeListener ( IMapChangeListener listener)


int size ()


String toString ()


Collection 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 org.eclipse.core.databinding.observable. IObservable

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

Constructor Detail

DecoratingObservableMap

public DecoratingObservableMap(
IObservableMap 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 listener)

Specified by:: addMapChangeListener in interface IObservableMap

removeMapChangeListener

public void removeMapChangeListener(
IMapChangeListener listener)

Specified by:: removeMapChangeListener in interface IObservableMap

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

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

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

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

fireMapChange

protected void fireMapChange(
MapDiff 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 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 Map

containsKey

public boolean containsKey(
Object key)

Specified by:: containsKey in interface Map
Specified by:: containsKey in interface IObservableMap

containsValue

public boolean containsValue(
Object value)

Specified by:: containsValue in interface Map
Specified by:: containsValue in interface IObservableMap

entrySet

public 
Set entrySet()

Specified by:: entrySet in interface Map
Specified by:: entrySet in interface IObservableMap

get

public 
Object get(
Object key)

Specified by:: get in interface Map
Specified by:: get in interface IObservableMap

isEmpty

public boolean isEmpty()

Specified by:: isEmpty in interface Map
Specified by:: isEmpty in interface IObservableMap

keySet

public 
Set keySet()

Specified by:: keySet in interface Map
Specified by:: keySet in interface IObservableMap

put

public 
Object put(
Object key,
                  
Object value)

Specified by:: put in interface Map
Specified by:: put in interface IObservableMap

putAll

public void putAll(
Map m)

Specified by:: putAll in interface Map

remove

public 
Object remove(
Object key)

Specified by:: remove in interface Map
Specified by:: remove in interface IObservableMap

size

public int size()

Specified by:: size in interface Map
Specified by:: size in interface IObservableMap

values

public 
Collection values()

Specified by:: values in interface Map
Specified by:: values in interface IObservableMap

equals

public boolean equals(
Object o)

Specified by:: equals in interface Map
Specified by:: equals in interface IObservableMap
Overrides:: equals in class DecoratingObservable

hashCode

public int hashCode()

Specified by:: hashCode in interface Map
Specified by:: hashCode in interface IObservableMap
Overrides:: hashCode in class DecoratingObservable

toString

public 
String toString()

Overrides:: toString in class 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(
Object listenerType,
                           
IObservablesListener listener)

Parameters:: listenerType -; listener -

removeListener

protected void removeListener(
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 
Object clone()
                throws 
CloneNotSupportedException

Overrides:: clone in class Object

Throws:: CloneNotSupportedException