Eclipse Platform
Release 3.6

org.eclipse.core.databinding.property.set
Class SimpleSetProperty

java.lang.Object
  extended by org.eclipse.core.databinding.property.set.SetProperty
      extended by org.eclipse.core.databinding.property.set.SimpleSetProperty
All Implemented Interfaces:
IProperty, ISetProperty
Direct Known Subclasses:
ViewerSetProperty

public abstract class SimpleSetProperty
extends SetProperty

Simplified abstract implementation of ISetProperty. This class takes care of most of the functional requirements for an ISetProperty implementation, leaving only the property-specific details to subclasses.

Subclasses must implement these methods:

In addition, we recommended overriding Object.toString() to return a description suitable for debugging purposes.

Since:
1.2

Constructor Summary
SimpleSetProperty()
           
 
Method Summary
abstract  INativePropertyListener adaptListener(ISimplePropertyListener listener)
          Returns a listener capable of adding or removing itself as a listener on a source object using the the source's "native" listener API.
protected abstract  Set doGetSet(Object source)
          Returns an unmodifiable Set with the current contents of the source's set property
protected abstract  void doSetSet(Object source, Set set, SetDiff diff)
          Updates the property on the source with the specified change.
 Set getSet(Object source)
          Returns a Set with the current contents of the source's set property
 IObservableSet observe(Realm realm, Object source)
          Returns an observable set observing this set property on the given property source
 void setSet(Object source, Set set, SetDiff diff)
          Updates the property on the source with the specified change.
 
Methods inherited from class org.eclipse.core.databinding.property.set.SetProperty
observe, observeDetail, setFactory, setFactory, values
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.core.databinding.property.set.ISetProperty
getElementType
 

Constructor Detail

SimpleSetProperty

public SimpleSetProperty()
Method Detail

observe

public IObservableSet observe(Realm realm,
                              Object source)
Description copied from interface: ISetProperty
Returns an observable set observing this set property on the given property source

Parameters:
realm - the observable's realm
source - the property source
Returns:
an observable set observing this set property on the given property source

getSet

public final Set getSet(Object source)
Returns a Set with the current contents of the source's set property

Parameters:
source - the property source
Returns:
a Set with the current contents of the source's set property
Restriction:
This method is not intended to be referenced by clients.

doGetSet

protected abstract Set doGetSet(Object source)
Returns an unmodifiable Set with the current contents of the source's set property

Parameters:
source - the property source
Returns:
an unmodifiable Set with the current contents of the source's set property
Restriction:
This method is not intended to be referenced by clients.

setSet

public final void setSet(Object source,
                         Set set,
                         SetDiff diff)
Updates the property on the source with the specified change.

Parameters:
source - the property source
set - the new set
diff - a diff describing the change
Restriction:
This method is not intended to be referenced by clients.

doSetSet

protected abstract void doSetSet(Object source,
                                 Set set,
                                 SetDiff diff)
Updates the property on the source with the specified change.

Parameters:
source - the property source
set - the new set
diff - a diff describing the change
Restriction:
This method is not intended to be referenced by clients.

adaptListener

public abstract INativePropertyListener adaptListener(ISimplePropertyListener listener)
Returns a listener capable of adding or removing itself as a listener on a source object using the the source's "native" listener API. Events received from the source objects are parlayed to the specified listener argument.

This method returns null if the source object has no listener APIs for this property.

Parameters:
listener - the property listener to receive events
Returns:
a native listener which parlays property change events to the specified listener, or null if the source object has no listener APIs for this property.
Restriction:
This method is not intended to be referenced by clients.

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.