architecture/com.splendo.kaluga.architecture.observable/BaseSubject

BaseSubject

actual abstract class BaseSubject<R : T, T, OO : ObservableOptional<R>>(observation: Observation<R, T, OO>, stateFlowToBind: suspend () -> StateFlow<R?>) : AbstractBaseSubject<R, T, OO>

An abstract class that extends AbstractBaseSubject.

Parameters

the type of value to expect.

the type of result to expect. Must be a subclass of T.

the type of ObservableOptional to store the result in.

observation

The Observation to handle observing the value.

stateFlowToBind

A function to get the StateFlow that will automatically call SuspendableSetter.set when a new value is posted after BasicSubject.post has been called.

expect abstract class BaseSubject<R : T, T, OO : ObservableOptional<R>>(observation: Observation<R, T, OO>, stateFlowToBind: suspend () -> StateFlow<R?>) : AbstractBaseSubject<R, T, OO>

An abstract class that extends AbstractBaseSubject.

Parameters

the type of value to expect.

the type of result to expect. Must be a subclass of T.

the type of ObservableOptional to store the result in.

observation

The Observation to handle observing the value.

stateFlowToBind

A function to get the StateFlow that will automatically call SuspendableSetter.set when a new value is posted after BasicSubject.post has been called.

Inheritors

AbstractBaseInitializedSubject

AbstractBaseUninitializedSubject

AbstractBaseDefaultSubject

actual abstract class BaseSubject<R : T, T, OO : ObservableOptional<R>>

An abstract class that extends AbstractBaseSubject.

Parameters

the type of value to expect.

the type of result to expect. Must be a subclass of T.

the type of ObservableOptional to store the result in.

observation

The Observation to handle observing the value.

stateFlowToBind

A function to get the StateFlow that will automatically call SuspendableSetter.set when a new value is posted after BasicSubject.post has been called.

actual abstract class BaseSubject<R : T, T, OO : ObservableOptional<R>>(observation: Observation<R, T, OO>, stateFlowToBind: suspend () -> StateFlow<R?>) : AbstractBaseSubject<R, T, OO>

An abstract class that extends AbstractBaseSubject.

Parameters

the type of value to expect.

the type of result to expect. Must be a subclass of T.

the type of ObservableOptional to store the result in.

observation

The Observation to handle observing the value.

stateFlowToBind

A function to get the StateFlow that will automatically call SuspendableSetter.set when a new value is posted after BasicSubject.post has been called.

actual abstract class BaseSubject<R : T, T, OO : ObservableOptional<R>>(observation: Observation<R, T, OO>, stateFlowToBind: suspend () -> StateFlow<R?>) : AbstractBaseSubject<R, T, OO>

An abstract class that extends AbstractBaseSubject.

Parameters

the type of value to expect.

the type of result to expect. Must be a subclass of T.

the type of ObservableOptional to store the result in.

observation

The Observation to handle observing the value.

stateFlowToBind

A function to get the StateFlow that will automatically call SuspendableSetter.set when a new value is posted after BasicSubject.post has been called.

Constructors

BaseSubject

actual constructor(observation: Observation<R, T, OO>, stateFlowToBind: suspend () -> StateFlow<R?>)

expect constructor(observation: Observation<R, T, OO>, stateFlowToBind: suspend () -> StateFlow<R?>)

actual constructor(observation: Observation<R, T, OO>, stateFlowToBind: suspend () -> StateFlow<R?>)

Properties

currentOrNull

open override val currentOrNull: T?

The current value T or null being observed

open override val currentOrNull: T?

The current value T or null being observed

open override val currentOrNull: T?

The current value T or null being observed

open override val currentOrNull: T?

The current value T or null being observed

initialValue

open override val initialValue: ObservableOptional<T>

The initial ObservableOptional value of T.

open override val initialValue: ObservableOptional<T>

The initial ObservableOptional value of T.

open override val initialValue: ObservableOptional<T>

The initial ObservableOptional value of T.

open override val initialValue: ObservableOptional<T>

The initial ObservableOptional value of T.

liveDataObserver

val <R : T, T, OO : ObservableOptional<R>> BasicSubject<R, T, OO>.liveDataObserver: Observer<T>

The Observer that observes the observable value.

mutableLiveData

val mutableLiveData: MutableLiveData<R>

The MutableLiveData synchronizing the value of the subject.

Functions

bind

actual override fun bind(coroutineScope: CoroutineScope, context: CoroutineContext)

Bind changes in value to a CoroutineScope in a CoroutineContext

expect override fun bind(coroutineScope: CoroutineScope, context: CoroutineContext)

Bind changes in value to a CoroutineScope in a CoroutineContext

actual override fun bind(coroutineScope: CoroutineScope, context: CoroutineContext)

Bind changes in value to a CoroutineScope in a CoroutineContext

actual override fun bind(coroutineScope: CoroutineScope, context: CoroutineContext)

Bind changes in value to a CoroutineScope in a CoroutineContext

bind

fun <R : T, T, OO : ObservableOptional<R>> BasicSubject<R, T, OO>.bind(coroutineScope: CoroutineScope)

Convenience method for BasicSubject that calls BasicSubject.bind using the CoroutineContext of the provided CoroutineScope

getValue

abstract operator fun getValue(thisRef: Any?, property: KProperty<*>): OO

liveDataObserver

fun liveDataObserver(): Observer<R>

Gets an Observer to observe changes to this subject.

observe

open override fun observe(onNext: (R?) -> Unit): Disposable

Creates an observation that calls onNext each time a new value is observed until the resulting Disposable is disposed

open override fun observe(onNext: (R?) -> Unit): Disposable

Creates an observation that calls onNext each time a new value is observed until the resulting Disposable is disposed

open override fun observe(onNext: (R?) -> Unit): Disposable

Creates an observation that calls onNext each time a new value is observed until the resulting Disposable is disposed

open override fun observe(onNext: (R?) -> Unit): Disposable

Creates an observation that calls onNext each time a new value is observed until the resulting Disposable is disposed

post

abstract fun post(newValue: T)

Updates the value of this Postable

abstract fun post(newValue: T)

Updates the value of this Postable

abstract fun post(newValue: T)

Updates the value of this Postable

abstract fun post(newValue: T)

Updates the value of this Postable

set

abstract suspend fun set(newValue: T)

Updates the value of this Postable in a suspended manner.

abstract suspend fun set(newValue: T)

Updates the value of this Postable in a suspended manner.

abstract suspend fun set(newValue: T)

Updates the value of this Postable in a suspended manner.

abstract suspend fun set(newValue: T)

Updates the value of this Postable in a suspended manner.

toDefaultObservable

fun <R : T, T> ReadOnlyProperty<Any?, T?>.toDefaultObservable(defaultValue: R): ReadOnlyPropertyDefaultObservable<R, T?>

Converts a ReadOnlyProperty into a ReadOnlyPropertyDefaultObservable

toInitializedObservable

fun <T> ReadOnlyProperty<Any?, T>.toInitializedObservable(): ReadOnlyPropertyInitializedObservable<T>

Converts a ReadOnlyProperty into a ReadOnlyPropertyInitializedObservable