Package io.realm.rx

Interface RxObservableFactory

All Known Implementing Classes:

RealmObservableFactory

public interface RxObservableFactory

Factory interface for creating Rx Observables for Realm classes.

Method Summary

Modifier and Type	Method	Description
Observable<ObjectChange<DynamicRealmObject>>	changesetsFrom(DynamicRealm realm, DynamicRealmObject object)	Creates an Observable for a RealmObject.
<E> Observable<CollectionChange<RealmList<E>>>	changesetsFrom(DynamicRealm realm, RealmList<E> list)	Creates an Observable for a RealmList.
<E> Observable<CollectionChange<RealmResults<E>>>	changesetsFrom(DynamicRealm realm, RealmResults<E> results)	Creates an Observable for a RealmResults.
<E extends RealmModel> Observable<ObjectChange<E>>	changesetsFrom(Realm realm, E object)	Creates an Observable for a RealmObject.
<E> Observable<CollectionChange<RealmList<E>>>	changesetsFrom(Realm realm, RealmList<E> list)	Creates an Observable for a RealmList.
<E> Observable<CollectionChange<RealmResults<E>>>	changesetsFrom(Realm realm, RealmResults<E> results)	Creates an Observable for a RealmResults.
Flowable<DynamicRealm>	from(DynamicRealm realm)	Creates a Flowable for a DynamicRealm.
Flowable<DynamicRealmObject>	from(DynamicRealm realm, DynamicRealmObject object)	Creates a Flowable for a DynamicRealmObject.
<E> Flowable<RealmList<E>>	from(DynamicRealm realm, RealmList<E> list)	Creates a Flowable for a RealmList.
<E> Single<RealmQuery<E>>	from(DynamicRealm realm, RealmQuery<E> query)	Creates a Single from a RealmQuery.
<E> Flowable<RealmResults<E>>	from(DynamicRealm realm, RealmResults<E> results)	Creates a Flowable for a RealmResults.
Flowable<Realm>	from(Realm realm)	Creates a Flowable for a Realm.
<E extends RealmModel> Flowable<E>	from(Realm realm, E object)	Creates a Flowable for a RealmObject.
<E> Flowable<RealmList<E>>	from(Realm realm, RealmList<E> list)	Creates an Observable for a RealmList.
<E> Single<RealmQuery<E>>	from(Realm realm, RealmQuery<E> query)	Creates a Single from a RealmQuery.
<E> Flowable<RealmResults<E>>	from(Realm realm, RealmResults<E> results)	Creates a Flowable for a RealmResults.

Method Detail

from

Flowable<Realm> from(Realm realm)

Creates a Flowable for a Realm. It should emit the initial state of the Realm when subscribed to and on each subsequent update of the Realm.

Realm flowables are hot as Realms are automatically kept up to date.

Parameters:

realm - Realm to listen to changes for.

Returns:

Rx observable that emit all updates to the Realm.

from

Flowable<DynamicRealm> from(DynamicRealm realm)

Creates a Flowable for a DynamicRealm. It should emit the initial state of the Realm when subscribed to and on each subsequent update of the Realm.

DynamicRealm observables are hot as DynamicRealms are automatically kept up to date.

Parameters:

realm - DynamicRealm to listen to changes for.

Returns:

Rx observable that emit all updates to the DynamicRealm.

from

<E> Flowable<RealmResults<E>> from(Realm realm,
                                   RealmResults<E> results)

Creates a Flowable for a RealmResults. It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults.

RealmResults observables are hot as RealmResults are automatically kept up to date.

Type Parameters:

E - type of RealmObject

Parameters:

results - RealmResults to listen to changes for.

realm - Realm instance results are coming from.

Returns:

Rx observable that emit all updates to the RealmObject.

changesetsFrom

<E> Observable<CollectionChange<RealmResults<E>>> changesetsFrom(Realm realm,
                                                                 RealmResults<E> results)

Creates an Observable for a RealmResults. It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults it should emit the RealmResults + the OrderedCollectionChangeSet that describes the update.

Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefor be left to users.

Type Parameters:

E - type of RealmObject

Parameters:

results - RealmResults to listen to changes for.

realm - Realm instance results are coming from.

Returns:

Rx observable that emit all updates + their changeset.

from

<E> Flowable<RealmResults<E>> from(DynamicRealm realm,
                                   RealmResults<E> results)

Creates a Flowable for a RealmResults. It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults.

Realm observables are hot as RealmResults are automatically kept up to date.

Parameters:

results - RealmResults to listen to changes for.

realm - DynamicRealm instance results are coming from.

Returns:

Rx observable that emit all updates to the RealmResults.

changesetsFrom

<E> Observable<CollectionChange<RealmResults<E>>> changesetsFrom(DynamicRealm realm,
                                                                 RealmResults<E> results)

Creates an Observable for a RealmResults. It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults it should emit the RealmResults + the OrderedCollectionChangeSet that describes the update.

Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefor be left to users.

Parameters:

results - RealmResults to listen to changes for.

realm - Realm instance results are coming from.

Returns:

Rx observable that emit all updates + their changeset.

from

<E> Flowable<RealmList<E>> from(Realm realm,
                                RealmList<E> list)

Creates an Observable for a RealmList. It should emit the initial list when subscribed to and on each subsequent update of the RealmList.

RealmList observables are hot as RealmLists are automatically kept up to date.

Note: RealmChangeListener is currently not supported on RealmLists.

Type Parameters:

E - type of query target

Parameters:

list - RealmObject to listen to changes for.

realm - Realm instance list is coming from.

changesetsFrom

<E> Observable<CollectionChange<RealmList<E>>> changesetsFrom(Realm realm,
                                                              RealmList<E> list)

Creates an Observable for a RealmList. It should emit the initial RealmList when subscribed to and on each subsequent update of the RealmIst it should emit the RealmList + the OrderedCollectionChangeSet that describes the update.

Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefor be left to users.

Type Parameters:

E - type of RealmObject

Parameters:

list - RealmList to listen to changes for.

realm - Realm instance list is coming from.

Returns:

Rx observable that emit all updates + their changeset.

from

<E> Flowable<RealmList<E>> from(DynamicRealm realm,
                                RealmList<E> list)

Creates a Flowable for a RealmList. It should emit the initial list when subscribed to and on each subsequent update of the RealmList.

RealmList observables are hot as RealmLists are automatically kept up to date.

Note: RealmChangeListener is currently not supported on RealmLists.

Parameters:

list - RealmList to listen to changes for.

realm - DynamicRealm instance list is coming from.

changesetsFrom

<E> Observable<CollectionChange<RealmList<E>>> changesetsFrom(DynamicRealm realm,
                                                              RealmList<E> list)

Creates an Observable for a RealmList. It should emit the initial RealmList when subscribed to and on each subsequent update of the RealmList it should emit the RealmList + the OrderedCollectionChangeSet that describes the update.

Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefor be left to users.

Parameters:

list - RealmList to listen to changes for.

realm - Realm instance list is coming from.

Returns:

Rx observable that emit all updates + their changeset.

from

<E extends RealmModel> Flowable<E> from(Realm realm,
                                        E object)

Creates a Flowable for a RealmObject. It should emit the initial object when subscribed to and on each subsequent update of the object.

RealmObject observables are hot as RealmObjects are automatically kept up to date.

Type Parameters:

E - type of query target

Parameters:

object - RealmObject to listen to changes for.

realm - Realm instance object is coming from.

changesetsFrom

<E extends RealmModel> Observable<ObjectChange<E>> changesetsFrom(Realm realm,
                                                                  E object)

Creates an Observable for a RealmObject. It should emit the initial object when subscribed to and on each subsequent update of the object it should emit the object + the ObjectChangeSet that describes the update.

Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user.

Type Parameters:

E - type of RealmObject

Parameters:

object - RealmObject to listen to changes for.

realm - Realm instance object is coming from.

from

Flowable<DynamicRealmObject> from(DynamicRealm realm,
                                  DynamicRealmObject object)

Creates a Flowable for a DynamicRealmObject. It should emit the initial object when subscribed to and on each subsequent update of the object.

DynamicRealmObject observables are hot as DynamicRealmObjects automatically are kept up to date.

Parameters:

object - DynamicRealmObject to listen to changes for.

realm - DynamicRealm instance object is coming from.

changesetsFrom

Observable<ObjectChange<DynamicRealmObject>> changesetsFrom(DynamicRealm realm,
                                                            DynamicRealmObject object)

Creates an Observable for a RealmObject. It should emit the initial object when subscribed to and on each subsequent update of the object it should emit the object + the ObjectChangeSet that describes the update.

Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user.

Parameters:

object - RealmObject to listen to changes for.

realm - Realm instance object is coming from.

from

<E> Single<RealmQuery<E>> from(Realm realm,
                               RealmQuery<E> query)

Creates a Single from a RealmQuery. It should emit the query and then complete.

A RealmQuery observable is cold.

Type Parameters:

E - type of query target

Parameters:

query - RealmQuery to emit.

realm - Realm instance query is coming from.

from

<E> Single<RealmQuery<E>> from(DynamicRealm realm,
                               RealmQuery<E> query)

Creates a Single from a RealmQuery. It should emit the query and then complete.

A RealmQuery observable is cold.

Parameters:

query - RealmObject to listen to changes for.

realm - DynamicRealm instance query is coming from.