Eclipse Platform
Release 3.6

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

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

public abstract class SetProperty
extends Object
implements ISetProperty

Abstract implementation of ISetProperty

Since:
1.2

Constructor Summary
SetProperty()
           
 
Method Summary
protected  Set doGetSet(Object source)
          Returns a Set with the current contents of the source's set property
protected  void doSetSet(Object source, Set set)
          Updates the property on the source with the specified change.
protected  void doUpdateSet(Object source, SetDiff diff)
          Updates the property on the source with the specified change.
 Set getSet(Object source)
          Returns an unmodifiable Set with the current contents of the source's set property
 IObservableSet observe(Object source)
          Returns an observable set observing this set property on the given property source
 IObservableSet observeDetail(IObservableValue master)
          Returns an observable set on the master observable's realm which tracks this property of the current value of master.
 IObservableFactory setFactory()
          Returns a factory for creating observable sets tracking this property of a particular property source.
 IObservableFactory setFactory(Realm realm)
          Returns a factory for creating observable sets in the given realm, tracking this property of a particular property source.
 void setSet(Object source, Set set)
          Updates the property on the source with the specified change.
 void updateSet(Object source, SetDiff diff)
          Updates the property on the source with the specified change.
 IMapProperty values(IValueProperty detailValues)
          Returns the nested combination of this property and the specified detail value property.
 
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, observe
 

Constructor Detail

SetProperty

public SetProperty()
Method Detail

getSet

public final Set getSet(Object source)
Description copied from interface: ISetProperty
Returns an unmodifiable Set with the current contents of the source's set property

Specified by:
getSet in interface ISetProperty
Parameters:
source - the property source (may be null)
Returns:
an unmodifiable Set with the current contents of the source's set property
Since:
1.3

doGetSet

protected Set doGetSet(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
Since:
1.3
Restriction:
This method is not intended to be referenced by clients.

setSet

public final void setSet(Object source,
                         Set set)
Description copied from interface: ISetProperty
Updates the property on the source with the specified change.

Note: This method is made available to facilitate basic property access. However if the property source lacks property change notification, then observables on the source object may not be notified of the change. In most cases it is preferable to modify the source through an IObservableSet than through the property directly.

Specified by:
setSet in interface ISetProperty
Parameters:
source - the property source (may be null)
set - the new set
Since:
1.3

doSetSet

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

Parameters:
source - the property source
set - the new set
Since:
1.3
Restriction:
This method is not intended to be referenced by clients.

updateSet

public final void updateSet(Object source,
                            SetDiff diff)
Description copied from interface: ISetProperty
Updates the property on the source with the specified change.

Note: This method is made available to facilitate basic property access. However if the property source lacks property change notification, then observables on the source object may not be notified of the change. In most cases it is preferable to modify the source through an IObservableSet than through the property directly.

Specified by:
updateSet in interface ISetProperty
Parameters:
source - the property source (may be null)
diff - a diff describing the change
Since:
1.3

doUpdateSet

protected void doUpdateSet(Object source,
                           SetDiff diff)
Updates the property on the source with the specified change.

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

observe

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

Specified by:
observe in interface ISetProperty
Parameters:
source - the property source
Returns:
an observable set observing this set property on the given property source

setFactory

public IObservableFactory setFactory()
Description copied from interface: ISetProperty
Returns a factory for creating observable sets tracking this property of a particular property source.

Specified by:
setFactory in interface ISetProperty
Returns:
a factory for creating observable sets tracking this property of a particular property source.

setFactory

public IObservableFactory setFactory(Realm realm)
Description copied from interface: ISetProperty
Returns a factory for creating observable sets in the given realm, tracking this property of a particular property source.

Specified by:
setFactory in interface ISetProperty
Parameters:
realm - the realm
Returns:
a factory for creating observable sets in the given realm, tracking this property of a particular property source.

observeDetail

public IObservableSet observeDetail(IObservableValue master)
Description copied from interface: ISetProperty
Returns an observable set on the master observable's realm which tracks this property of the current value of master.

Specified by:
observeDetail in interface ISetProperty
Parameters:
master - the master observable
Returns:
an observable set on the given realm which tracks this property of the current value of master.

values

public final IMapProperty values(IValueProperty detailValues)
Description copied from interface: ISetProperty
Returns the nested combination of this property and the specified detail value property. Note that because this property is a projection of value properties over a set, the only modifications supported are through the IObservableMap.put(Object, Object) and Map.putAll(java.util.Map) methods. In the latter case, this property does not put entries for keys not already in the master key set. Modifications made through the returned property are delegated to the detail property, using the corresponding set element from the master property as the source.

Specified by:
values in interface ISetProperty
Parameters:
detailValues - the detail property
Returns:
the nested combination of the master set and detail value properties

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

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