Package io.realm.coroutines

Class RealmFlowFactory

java.lang.Object

io.realm.coroutines.RealmFlowFactory

All Implemented Interfaces:

FlowFactory

public class RealmFlowFactory
extends Object
implements FlowFactory

Factory class used to create coroutine Flows.

This class is used by default unless overridden in RealmConfiguration.Builder.flowFactory(FlowFactory).

Constructor Summary

Constructors

Constructor	Description
RealmFlowFactory(Boolean returnFrozenObjects)	Constructor for the Flow factory.

Method Summary

Modifier and Type	Method	Description
kotlinx.coroutines.flow.Flow<ObjectChange<DynamicRealmObject>>	changesetFrom(DynamicRealm dynamicRealm, DynamicRealmObject dynamicRealmObject)	Creates a Flow for a DynamicRealmObject.
<T> kotlinx.coroutines.flow.Flow<CollectionChange<RealmList<T>>>	changesetFrom(DynamicRealm dynamicRealm, RealmList<T> list)	Creates a Flow for a RealmList.
<T> kotlinx.coroutines.flow.Flow<CollectionChange<RealmResults<T>>>	changesetFrom(DynamicRealm dynamicRealm, RealmResults<T> results)	Creates a Flow for a RealmResults instance.
<T> kotlinx.coroutines.flow.Flow<CollectionChange<RealmList<T>>>	changesetFrom(Realm realm, RealmList<T> list)	Creates a Flow for a RealmList.
<T> kotlinx.coroutines.flow.Flow<CollectionChange<RealmResults<T>>>	changesetFrom(Realm realm, RealmResults<T> results)	Creates a Flow for a RealmResults instance.
<T extends RealmModel> kotlinx.coroutines.flow.Flow<ObjectChange<T>>	changesetFrom(Realm realm, T realmObject)	Creates a Flow for a RealmObject.
kotlinx.coroutines.flow.Flow<DynamicRealm>	from(DynamicRealm dynamicRealm)	Creates a Flow for a DynamicRealm.
kotlinx.coroutines.flow.Flow<DynamicRealmObject>	from(DynamicRealm dynamicRealm, DynamicRealmObject dynamicRealmObject)	Creates a Flow for a DynamicRealmObject.
<T> kotlinx.coroutines.flow.Flow<RealmList<T>>	from(DynamicRealm dynamicRealm, RealmList<T> realmList)	Creates a Flow for a RealmList.
<T> kotlinx.coroutines.flow.Flow<RealmResults<T>>	from(DynamicRealm dynamicRealm, RealmResults<T> results)	Creates a Flow for a RealmResults.
kotlinx.coroutines.flow.Flow<Realm>	from(Realm realm)	Creates a Flow for a Realm.
<T> kotlinx.coroutines.flow.Flow<RealmList<T>>	from(Realm realm, RealmList<T> realmList)	Creates a Flow for a RealmList.
<T> kotlinx.coroutines.flow.Flow<RealmResults<T>>	from(Realm realm, RealmResults<T> results)	Creates a Flow for a RealmResults.
<T extends RealmModel> kotlinx.coroutines.flow.Flow<T>	from(Realm realm, T realmObject)	Creates a Flow for a RealmObject.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RealmFlowFactory

public RealmFlowFactory(Boolean returnFrozenObjects)

Constructor for the Flow factory.

Parameters:

returnFrozenObjects - whether the emissions should return frozen objects or not.

Method Detail

from

public kotlinx.coroutines.flow.Flow<Realm> from(@Nonnull
                                                Realm realm)

Description copied from interface: FlowFactory

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

Specified by:

from in interface FlowFactory

Parameters:

realm - Realm instance being observed for changes to be emitted by the flow.

Returns:

Flow that emits all updates to the Realm.

from

public kotlinx.coroutines.flow.Flow<DynamicRealm> from(@Nonnull
                                                       DynamicRealm dynamicRealm)

Description copied from interface: FlowFactory

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

Specified by:

from in interface FlowFactory

Parameters:

dynamicRealm - DynamicRealm instance being observed for changes to be emitted by the flow.

Returns:

Flow that emits all updates to the Realm.

from

public <T> kotlinx.coroutines.flow.Flow<RealmResults<T>> from(@Nonnull
                                                              Realm realm,
                                                              @Nonnull
                                                              RealmResults<T> results)

Description copied from interface: FlowFactory

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

Specified by:

from in interface FlowFactory

Type Parameters:

T - type of RealmObject.

Parameters:

realm - Realm instance from where the results are coming.

results - RealmResults instance being observed for changes to be emitted by the flow.

Returns:

Flow that emits all updates to the RealmObject.

changesetFrom

public <T> kotlinx.coroutines.flow.Flow<CollectionChange<RealmResults<T>>> changesetFrom(@Nonnull
                                                                                         Realm realm,
                                                                                         @Nonnull
                                                                                         RealmResults<T> results)

Description copied from interface: FlowFactory

Creates a Flow for a RealmResults instance. It should emit the initial results when subscribed to and on each subsequent update of the results it should emit the results plus the CollectionChange 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.

Specified by:

changesetFrom in interface FlowFactory

Parameters:

realm - Realm instance from where the object is coming.

results - RealmResults instance being observed for changes to be emitted by the flow.

Returns:

Flow that emits all updates to the RealmResults.

from

public <T> kotlinx.coroutines.flow.Flow<RealmResults<T>> from(@Nonnull
                                                              DynamicRealm dynamicRealm,
                                                              @Nonnull
                                                              RealmResults<T> results)

Description copied from interface: FlowFactory

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

Specified by:

from in interface FlowFactory

Type Parameters:

T - type of RealmObject.

Parameters:

dynamicRealm - DynamicRealm instance from where the results are coming.

results - RealmResults instance being observed for changes to be emitted by the flow.

Returns:

Flow that emits all updates to the RealmObject.

changesetFrom

public <T> kotlinx.coroutines.flow.Flow<CollectionChange<RealmResults<T>>> changesetFrom(@Nonnull
                                                                                         DynamicRealm dynamicRealm,
                                                                                         @Nonnull
                                                                                         RealmResults<T> results)

Description copied from interface: FlowFactory

Creates a Flow for a RealmResults instance. It should emit the initial results when subscribed to and on each subsequent update of the results it should emit the results plus the CollectionChange 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.

Specified by:

changesetFrom in interface FlowFactory

Parameters:

dynamicRealm - DynamicRealm instance from where the object is coming.

results - RealmResults instance being observed for changes to be emitted by the flow.

Returns:

Flow that emits all updates to the RealmResults.

from

public <T> kotlinx.coroutines.flow.Flow<RealmList<T>> from(@Nonnull
                                                           Realm realm,
                                                           @Nonnull
                                                           RealmList<T> realmList)

Description copied from interface: FlowFactory

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

Note: RealmChangeListener is currently not supported on RealmLists.

Specified by:

from in interface FlowFactory

Type Parameters:

T - type of RealmObject

Parameters:

realm - Realm instance from where the results are coming.

realmList - RealmList instance being observed for changes to be emitted by the flow.

Returns:

Flow that emit all updates to the RealmList.

changesetFrom

public <T> kotlinx.coroutines.flow.Flow<CollectionChange<RealmList<T>>> changesetFrom(@Nonnull
                                                                                      Realm realm,
                                                                                      @Nonnull
                                                                                      RealmList<T> list)

Description copied from interface: FlowFactory

Creates a Flow for a RealmList. It should emit the initial list when subscribed to and on each subsequent update of the list it should emit the list plus the CollectionChange 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.

Specified by:

changesetFrom in interface FlowFactory

Parameters:

realm - Realm instance from where the object is coming.

list - RealmList instance being observed for changes to be emitted by the flow.

Returns:

Flow that emits all updates to the RealmList.

from

public <T> kotlinx.coroutines.flow.Flow<RealmList<T>> from(@Nonnull
                                                           DynamicRealm dynamicRealm,
                                                           @Nonnull
                                                           RealmList<T> realmList)

Description copied from interface: FlowFactory

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

Note: RealmChangeListener is currently not supported on RealmLists.

Specified by:

from in interface FlowFactory

Type Parameters:

T - type of RealmObject

Parameters:

dynamicRealm - DynamicRealm instance from where the results are coming.

realmList - RealmList instance being observed for changes to be emitted by the flow.

Returns:

Flow that emit all updates to the RealmList.

changesetFrom

public <T> kotlinx.coroutines.flow.Flow<CollectionChange<RealmList<T>>> changesetFrom(@Nonnull
                                                                                      DynamicRealm dynamicRealm,
                                                                                      @Nonnull
                                                                                      RealmList<T> list)

Description copied from interface: FlowFactory

Creates a Flow for a RealmList. It should emit the initial list when subscribed to and on each subsequent update of the list it should emit the list plus the CollectionChange 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.

Specified by:

changesetFrom in interface FlowFactory

Parameters:

dynamicRealm - DynamicRealm instance from where the object is coming.

list - RealmList instance being observed for changes to be emitted by the flow.

Returns:

Flow that emits all updates to the RealmList.

from

public <T extends RealmModel> kotlinx.coroutines.flow.Flow<T> from(@Nonnull
                                                                   Realm realm,
                                                                   @Nonnull
                                                                   T realmObject)

Description copied from interface: FlowFactory

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

Specified by:

from in interface FlowFactory

Type Parameters:

T - type of query target

Parameters:

realm - Realm instance from where the object is coming.

realmObject - RealmObject instance being observed for changes to be emitted by the flow.

Returns:

Flow that emits all updates to the DynamicRealmObject.

changesetFrom

public <T extends RealmModel> kotlinx.coroutines.flow.Flow<ObjectChange<T>> changesetFrom(@Nonnull
                                                                                          Realm realm,
                                                                                          @Nonnull
                                                                                          T realmObject)

Description copied from interface: FlowFactory

Creates a Flow 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 plus 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.

Specified by:

changesetFrom in interface FlowFactory

Parameters:

realm - Realm instance from where the object is coming.

realmObject - RealmObject instance being observed for changes to be emitted by the flow.

Returns:

Flow that emits all updates to the DynamicRealmObject.

from

public kotlinx.coroutines.flow.Flow<DynamicRealmObject> from(@Nonnull
                                                             DynamicRealm dynamicRealm,
                                                             @Nonnull
                                                             DynamicRealmObject dynamicRealmObject)

Description copied from interface: FlowFactory

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

Specified by:

from in interface FlowFactory

Parameters:

dynamicRealm - DynamicRealm instance from where the object is coming.

dynamicRealmObject - DynamicRealmObject instance being observed for changes to be emitted by the flow.

Returns:

Flow that emits all updates to the DynamicRealmObject.

changesetFrom

public kotlinx.coroutines.flow.Flow<ObjectChange<DynamicRealmObject>> changesetFrom(@Nonnull
                                                                                    DynamicRealm dynamicRealm,
                                                                                    @Nonnull
                                                                                    DynamicRealmObject dynamicRealmObject)

Description copied from interface: FlowFactory

Creates a Flow for a DynamicRealmObject. It should emit the initial object when subscribed to and on each subsequent update of the object it should emit the object plus 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.

Specified by:

changesetFrom in interface FlowFactory

Parameters:

dynamicRealm - DynamicRealm instance from where the object is coming.

dynamicRealmObject - DynamicRealmObject instance being observed for changes to be emitted by the flow.

Returns:

Flow that emits all updates to the DynamicRealmObject.