Eclipse Platform
Release 3.7

org.eclipse.core.databinding.property.value
Class ValueProperty

java.lang.Object
  extended by org.eclipse.core.databinding.property.value.ValueProperty
All Implemented Interfaces:
IProperty, IValueProperty
Direct Known Subclasses:
DelegatingValueProperty, SimpleValueProperty

public abstract class ValueProperty
extends Object
implements IValueProperty

Abstract implementation of IValueProperty

Since:
1.2

Constructor Summary
ValueProperty()
           
 
Method Summary
protected  Object doGetValue(Object source)
          Returns the value of the property on the specified source object
protected  void doSetValue(Object source, Object value)
          Sets the source's value property to the specified vlaue
 Object getValue(Object source)
          By default, this method returns null in case the source object is itself null.
 IListProperty list(IListProperty detailList)
          Returns the nested combination of this property and the specified detail list property.
 IMapProperty map(IMapProperty detailMap)
          Returns the nested combination of this property and the specified detail map property.
 IObservableValue observe(Object source)
          Returns an observable value observing this value property on the given property source.
 IObservableList observeDetail(IObservableList master)
          Returns an observable list on the master observable's realm which tracks this property on each element of master.
 IObservableMap observeDetail(IObservableMap master)
          Returns an observable map on the master observable's realm where the map's key set is the same as the master observable map, and where each value is the property value of the corresponding value in the master observable map.
 IObservableMap observeDetail(IObservableSet master)
          Returns an observable map on the master observable's realm where the map's key set is the specified master set, and where each key maps to the current property value for each element.
 IObservableValue observeDetail(IObservableValue master)
          Returns an observable value on the master observable's realm which tracks this property on the current value of master.
 ISetProperty set(ISetProperty detailSet)
          Returns the nested combination of this property and the specified detail set property.
 void setValue(Object source, Object value)
          Sets this property on the specified property source to the specified value.
 IValueProperty value(IValueProperty detailValue)
          Returns the nested combination of this property and the specified detail value property.
 IObservableFactory valueFactory()
          Returns a factory for creating observable values tracking this property of a particular property source.
 IObservableFactory valueFactory(Realm realm)
          Returns a factory for creating observable values in the given realm, tracking this property of a particular property source.
 
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.value.IValueProperty
getValueType, observe
 

Constructor Detail

ValueProperty

public ValueProperty()
Method Detail

getValue

public Object getValue(Object source)
By default, this method returns null in case the source object is itself null. Otherwise, this method delegates to doGetValue(Object).

Clients may override this method if they e.g. want to return a specific default value in case the source object is null.

Specified by:
getValue in interface IValueProperty
Parameters:
source - the property source (may be null)
Returns:
the current value of this property on the specified property source.
Since:
1.3
See Also:
doGetValue(Object)

doGetValue

protected Object doGetValue(Object source)
Returns the value of the property on the specified source object

Parameters:
source - the property source
Returns:
the current value of the source's value property
Since:
1.3
Restriction:
This method is not intended to be referenced by clients.

setValue

public final void setValue(Object source,
                           Object value)
Description copied from interface: IValueProperty
Sets this property on the specified property source to the specified value.

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 call IObservableValue.setValue(Object) on the observable instead.

Specified by:
setValue in interface IValueProperty
Parameters:
source - the property source (may be null)
value - the new property value
Since:
1.3

doSetValue

protected void doSetValue(Object source,
                          Object value)
Sets the source's value property to the specified vlaue

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

observe

public IObservableValue observe(Object source)
Description copied from interface: IValueProperty
Returns an observable value observing this value property on the given property source.

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

valueFactory

public IObservableFactory valueFactory()
Description copied from interface: IValueProperty
Returns a factory for creating observable values tracking this property of a particular property source.

Specified by:
valueFactory in interface IValueProperty
Returns:
a factory for creating observable values tracking this property of a particular property source.

valueFactory

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

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

observeDetail

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

Specified by:
observeDetail in interface IValueProperty
Parameters:
master - the master observable
Returns:
an observable value which tracks this property of the current value of master.

observeDetail

public IObservableList observeDetail(IObservableList master)
Description copied from interface: IValueProperty
Returns an observable list on the master observable's realm which tracks this property on each element of master.

Specified by:
observeDetail in interface IValueProperty
Parameters:
master - the master observable
Returns:
an observable list which tracks this property on each element of the master observable.
Since:
1.4

observeDetail

public IObservableMap observeDetail(IObservableSet master)
Description copied from interface: IValueProperty
Returns an observable map on the master observable's realm where the map's key set is the specified master set, and where each key maps to the current property value for each element.

Specified by:
observeDetail in interface IValueProperty
Parameters:
master - the master observable
Returns:
an observable map that tracks the current value of this property for the elements in the given set.
Since:
1.4

observeDetail

public IObservableMap observeDetail(IObservableMap master)
Description copied from interface: IValueProperty
Returns an observable map on the master observable's realm where the map's key set is the same as the master observable map, and where each value is the property value of the corresponding value in the master observable map.

Specified by:
observeDetail in interface IValueProperty
Parameters:
master - the master observable
Returns:
an observable map on the master observable's realm which tracks the current value of this property for the elements in the given map's values collection
Since:
1.4

value

public final IValueProperty value(IValueProperty detailValue)
Description copied from interface: IValueProperty
Returns the nested combination of this property and the specified detail value property. Value modifications made through the returned property are delegated to the detail property, using the value of this property as the source.

Specified by:
value in interface IValueProperty
Parameters:
detailValue - the detail property
Returns:
the nested combination of the master and detail properties

list

public final IListProperty list(IListProperty detailList)
Description copied from interface: IValueProperty
Returns the nested combination of this property and the specified detail list property. List modifications made through the returned property are delegated to the detail property, using the value of the master property as the source.

Specified by:
list in interface IValueProperty
Parameters:
detailList - the detail property
Returns:
the nested combination of the master value and detail list properties

set

public final ISetProperty set(ISetProperty detailSet)
Description copied from interface: IValueProperty
Returns the nested combination of this property and the specified detail set property. Set modifications made through the returned property are delegated to the detail property, using the value of the master property as the source.

Specified by:
set in interface IValueProperty
Parameters:
detailSet - the detail property
Returns:
the nested combination of the master value and detail set properties

map

public final IMapProperty map(IMapProperty detailMap)
Description copied from interface: IValueProperty
Returns the nested combination of this property and the specified detail map property. Map modifications made through the returned property are delegated to the detail property, using the value of the master property as the source.

Specified by:
map in interface IValueProperty
Parameters:
detailMap - the detail property
Returns:
the nested combination of the master value and detial map properties

Eclipse Platform
Release 3.7

Guidelines for using Eclipse APIs.

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