Eclipse Platform
Release 3.4

org.eclipse.core.databinding.observable
Class Observables

java.lang.Object
  extended byorg.eclipse.core.databinding.observable.Observables

public class Observables
extends Object

Contains static methods to operate on or return Observables.

Since:
1.0

Constructor Summary
Observables()
           
 
Method Summary
static IObservableValue constantObservableValue(Object value)
          Returns an observable value with the given constant value.
static IObservableValue constantObservableValue(Object value, Object valueType)
          Returns an observable value with the given constant value.
static IObservableValue constantObservableValue(Realm realm, Object value)
          Returns an observable value with the given constant value.
static IObservableValue constantObservableValue(Realm realm, Object value, Object valueType)
          Returns an observable value with the given constant value.
static IObservableList emptyObservableList()
          Returns an empty observable list.
static IObservableList emptyObservableList(Object elementType)
          Returns an empty observable list of the given element type.
static IObservableList emptyObservableList(Realm realm)
          Returns an empty observable list belonging to the given realm.
static IObservableList emptyObservableList(Realm realm, Object elementType)
          Returns an empty observable list of the given element type and belonging to the given realm.
static IObservableSet emptyObservableSet()
          Returns an empty observable set.
static IObservableSet emptyObservableSet(Object elementType)
          Returns an empty observable set of the given element type.
static IObservableSet emptyObservableSet(Realm realm)
          Returns an empty observable set belonging to the given realm.
static IObservableSet emptyObservableSet(Realm realm, Object elementType)
          Returns an empty observable set of the given element type and belonging to the given realm.
static IObservableFactory mapEntryValueFactory(IObservableMap map, Object valueType)
          Returns a factory for creating obervable values tracking the value of the observable map entry identified by a particular key.
static IObservableValue observeDetailMapEntry(IObservableMap map, IObservableValue master, Object valueType)
          Helper method for MasterDetailObservables.detailValue(master, mapEntryValueFactory(map, valueType), valueType).
static IObservableValue observeMapEntry(IObservableMap map, Object key, Object valueType)
          Returns an observable value that tracks changes to the value of an observable map's entry specified by its key.
static IObservableValue observeStale(IObservable observable)
          Returns an observable value of type Boolean.TYPE which tracks whether the given observable is stale.
static IObservableList proxyObservableList(IObservableList target)
          Returns an observable list that contains the same elements as the given list, and fires the same events as the given list, but can be disposed of without disposing of the wrapped list.
static IObservableSet proxyObservableSet(IObservableSet target)
          Returns an observable set that contains the same elements as the given set, and fires the same events as the given set, but can be disposed of without disposing of the wrapped set.
static IObservableList staticObservableList(List list)
          Returns an observable list backed by the given list.
static IObservableList staticObservableList(List list, Object elementType)
          Returns an observable list of the given element type, backed by the given list.
static IObservableList staticObservableList(Realm realm, List list)
          Returns an observable list belonging to the given realm, backed by the given list.
static IObservableList staticObservableList(Realm realm, List list, Object elementType)
          Returns an observable list of the given element type and belonging to the given realm, backed by the given list.
static IObservableSet staticObservableSet(Realm realm, Set set)
          Returns an observable set belonging to the given realm, backed by the given set.
static IObservableSet staticObservableSet(Realm realm, Set set, Object elementType)
          Returns an observable set of the given element type and belonging to the given realm, backed by the given set.
static IObservableSet staticObservableSet(Set set)
          Returns an observable set backed by the given set.
static IObservableSet staticObservableSet(Set set, Object elementType)
          Returns an observable set of the given element type, backed by the given set.
static IObservableList unmodifiableObservableList(IObservableList list)
          Returns an unmodifiable observable list backed by the given observable list.
static IObservableSet unmodifiableObservableSet(IObservableSet set)
          Returns an unmodifiable observable set backed by the given observable set.
static IObservableValue unmodifiableObservableValue(IObservableValue value)
          Returns an unmodifiable observable value backed by the given observable value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Observables

public Observables()
Method Detail

unmodifiableObservableValue

public static IObservableValue unmodifiableObservableValue(IObservableValue value)
Returns an unmodifiable observable value backed by the given observable value.

Parameters:
value - the value to wrap in an unmodifiable value
Returns:
an unmodifiable observable value backed by the given observable value
Since:
1.1

constantObservableValue

public static IObservableValue constantObservableValue(Realm realm,
                                                       Object value,
                                                       Object valueType)
Returns an observable value with the given constant value.

Parameters:
realm - the observable's realm
value - the observable's constant value
valueType - the observable's value type
Returns:
an immutable observable value with the given constant value
Since:
1.1

constantObservableValue

public static IObservableValue constantObservableValue(Realm realm,
                                                       Object value)
Returns an observable value with the given constant value.

Parameters:
realm - the observable's realm
value - the observable's constant value
Returns:
an immutable observable value with the given constant value
Since:
1.1

constantObservableValue

public static IObservableValue constantObservableValue(Object value,
                                                       Object valueType)
Returns an observable value with the given constant value.

Parameters:
value - the observable's constant value
valueType - the observable's value type
Returns:
an immutable observable value with the given constant value
Since:
1.1

constantObservableValue

public static IObservableValue constantObservableValue(Object value)
Returns an observable value with the given constant value.

Parameters:
value - the observable's constant value
Returns:
an immutable observable value with the given constant value
Since:
1.1

unmodifiableObservableList

public static IObservableList unmodifiableObservableList(IObservableList list)
Returns an unmodifiable observable list backed by the given observable list.

Parameters:
list - the list to wrap in an unmodifiable list
Returns:
an unmodifiable observable list backed by the given observable list

unmodifiableObservableSet

public static IObservableSet unmodifiableObservableSet(IObservableSet set)
Returns an unmodifiable observable set backed by the given observable set.

Parameters:
set - the set to wrap in an unmodifiable set
Returns:
an unmodifiable observable set backed by the given observable set
Since:
1.1

emptyObservableList

public static IObservableList emptyObservableList()
Returns an empty observable list. The returned list continues to work after it has been disposed of and can be disposed of multiple times.

Returns:
an empty observable list.

emptyObservableList

public static IObservableList emptyObservableList(Object elementType)
Returns an empty observable list of the given element type. The returned list continues to work after it has been disposed of and can be disposed of multiple times.

Parameters:
elementType - the element type of the returned list
Returns:
an empty observable list
Since:
1.1

emptyObservableList

public static IObservableList emptyObservableList(Realm realm)
Returns an empty observable list belonging to the given realm. The returned list continues to work after it has been disposed of and can be disposed of multiple times.

Parameters:
realm - the realm of the returned list
Returns:
an empty observable list.

emptyObservableList

public static IObservableList emptyObservableList(Realm realm,
                                                  Object elementType)
Returns an empty observable list of the given element type and belonging to the given realm. The returned list continues to work after it has been disposed of and can be disposed of multiple times.

Parameters:
realm - the realm of the returned list
elementType - the element type of the returned list
Returns:
an empty observable list
Since:
1.1

emptyObservableSet

public static IObservableSet emptyObservableSet()
Returns an empty observable set. The returned set continues to work after it has been disposed of and can be disposed of multiple times.

Returns:
an empty observable set.

emptyObservableSet

public static IObservableSet emptyObservableSet(Object elementType)
Returns an empty observable set of the given element type. The returned set continues to work after it has been disposed of and can be disposed of multiple times.

Parameters:
elementType - the element type of the returned set
Returns:
an empty observable set
Since:
1.1

emptyObservableSet

public static IObservableSet emptyObservableSet(Realm realm)
Returns an empty observable set belonging to the given realm. The returned set continues to work after it has been disposed of and can be disposed of multiple times.

Parameters:
realm - the realm of the returned set
Returns:
an empty observable set.

emptyObservableSet

public static IObservableSet emptyObservableSet(Realm realm,
                                                Object elementType)
Returns an empty observable set of the given element type and belonging to the given realm. The returned set continues to work after it has been disposed of and can be disposed of multiple times.

Parameters:
realm - the realm of the returned set
elementType - the element type of the returned set
Returns:
an empty observable set
Since:
1.1

staticObservableSet

public static IObservableSet staticObservableSet(Set set)
Returns an observable set backed by the given set.

Parameters:
set - the set to wrap in an IObservableSet
Returns:
an observable set backed by the given set

staticObservableSet

public static IObservableSet staticObservableSet(Set set,
                                                 Object elementType)
Returns an observable set of the given element type, backed by the given set.

Parameters:
set - the set to wrap in an IObservableSet
elementType - the element type of the returned set
Returns:
Returns an observable set backed by the given unchanging set
Since:
1.1

staticObservableSet

public static IObservableSet staticObservableSet(Realm realm,
                                                 Set set)
Returns an observable set belonging to the given realm, backed by the given set.

Parameters:
realm - the realm of the returned set
set - the set to wrap in an IObservableSet
Returns:
an observable set backed by the given unchanging set

staticObservableSet

public static IObservableSet staticObservableSet(Realm realm,
                                                 Set set,
                                                 Object elementType)
Returns an observable set of the given element type and belonging to the given realm, backed by the given set.

Parameters:
realm - the realm of the returned set
set - the set to wrap in an IObservableSet
elementType - the element type of the returned set
Returns:
an observable set backed by the given set
Since:
1.1

proxyObservableSet

public static IObservableSet proxyObservableSet(IObservableSet target)
Returns an observable set that contains the same elements as the given set, and fires the same events as the given set, but can be disposed of without disposing of the wrapped set.

Parameters:
target - the set to wrap
Returns:
a disposable proxy for the given observable set

proxyObservableList

public static IObservableList proxyObservableList(IObservableList target)
Returns an observable list that contains the same elements as the given list, and fires the same events as the given list, but can be disposed of without disposing of the wrapped list.

Parameters:
target - the list to wrap
Returns:
a disposable proxy for the given observable list
Since:
1.1

staticObservableList

public static IObservableList staticObservableList(List list)
Returns an observable list backed by the given list.

Parameters:
list - the list to wrap in an IObservableList
Returns:
an observable list backed by the given unchanging list

staticObservableList

public static IObservableList staticObservableList(List list,
                                                   Object elementType)
Returns an observable list of the given element type, backed by the given list.

Parameters:
list - the list to wrap in an IObservableList
elementType - the element type of the returned list
Returns:
an observable list backed by the given unchanging list
Since:
1.1

staticObservableList

public static IObservableList staticObservableList(Realm realm,
                                                   List list)
Returns an observable list belonging to the given realm, backed by the given list.

Parameters:
realm - the realm of the returned list
list - the list to wrap in an IObservableList
Returns:
an observable list backed by the given unchanging list

staticObservableList

public static IObservableList staticObservableList(Realm realm,
                                                   List list,
                                                   Object elementType)
Returns an observable list of the given element type and belonging to the given realm, backed by the given list.

Parameters:
realm - the realm of the returned list
list - the list to wrap in an IObservableList
elementType - the element type of the returned list
Returns:
an observable list backed by the given unchanging list
Since:
1.1

observeStale

public static IObservableValue observeStale(IObservable observable)
Returns an observable value of type Boolean.TYPE which tracks whether the given observable is stale.

Parameters:
observable - the observable to track
Returns:
an observable value which tracks whether the given observable is stale
Since:
1.1

observeMapEntry

public static IObservableValue observeMapEntry(IObservableMap map,
                                               Object key,
                                               Object valueType)
Returns an observable value that tracks changes to the value of an observable map's entry specified by its key.

The state where the key does not exist in the map is equivalent to the state where the key exists and its value is null. The transition between these two states is not considered a value change and no event is fired.

Parameters:
map - the observable map whose entry will be tracked.
key - the key identifying the map entry to track.
valueType - the type of the value. May be null, meaning the value is untyped.
Returns:
an observable value that tracks the value associated with the specified key in the given map
Since:
1.1

mapEntryValueFactory

public static IObservableFactory mapEntryValueFactory(IObservableMap map,
                                                      Object valueType)
Returns a factory for creating obervable values tracking the value of the observable map entry identified by a particular key.

Parameters:
map - the observable map whose entry will be tracked.
valueType - the type of the value. May be null, meaning the value is untyped.
Returns:
a factory for creating observable values tracking the value of the observable map entry identified by a particular key object.
Since:
1.1

observeDetailMapEntry

public static IObservableValue observeDetailMapEntry(IObservableMap map,
                                                     IObservableValue master,
                                                     Object valueType)
Helper method for MasterDetailObservables.detailValue(master, mapEntryValueFactory(map, valueType), valueType).

Parameters:
map - the observable map whose entry will be tracked.
master - the observable value that identifies which map entry to track.
valueType - the type of the value. May be null, meaning the value is untyped.
Returns:
an observable value tracking the current value of the specified key in the given map an observable value that tracks the current value of the named property for the current value of the master observable value
Since:
1.1

Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

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