app.futured.arkitekt.rxusecases.disposables

Interface ObservableDisposablesOwner

All Known Subinterfaces:

DisposablesOwner

All Known Implementing Classes:

BaseRxViewModel

public ObservableDisposablesOwner

This interface gives your class ability to execute class ObservableUseCase use cases and automatically add resulting disposables to one composite disposable. You may find handy to implement this interface in custom Presenters, ViewHolders etc.

Consider using interface DisposablesOwner to support all of the basic RxJava 2 types.

It is your responsibility to clear this composite disposable when all running tasks should be stopped.

See Also:

class ObservableUseCase, interface DisposablesOwner

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ObservableDisposablesOwner.DefaultImpls This interface gives your class ability to execute class ObservableUseCase use cases and automatically add resulting disposables to one composite disposable. You may find handy to implement this interface in custom Presenters, ViewHolders etc.

Method Summary

Modifier and Type	Method and Description
<T> io.reactivex.disposables.Disposable	execute(ObservableUseCase<kotlin.Unit,T> $receiver, kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.ObservableUseCaseConfig.Builder<T>,kotlin.Unit> config) Executes the use case and adds its disposable to shared, automatically disposed, composite disposable. In case some variant of ObservableUseCase.execute method has already been called on this instance of class ObservableUseCase, previous one is disposed, no matter what current state of internal Observable is. This behavior can be disabled by passing false to ObservableUseCaseConfig.disposePrevious method.
<ARGS,T> io.reactivex.disposables.Disposable	execute(ObservableUseCase<ARGS,T> $receiver, ARGS args, kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.ObservableUseCaseConfig.Builder<T>,kotlin.Unit> config) Executes the use case and adds its disposable to shared, automatically disposed, composite disposable. In case some variant of ObservableUseCase.execute method has already been called on this instance of class ObservableUseCase, previous one is disposed, no matter what current state of internal Observable is. This behavior can be disabled by passing false to ObservableUseCaseConfig.disposePrevious method.
<T> io.reactivex.disposables.Disposable	executeStream(io.reactivex.Observable<T> $receiver, kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.ObservableUseCaseConfig.Builder<T>,kotlin.Unit> config) Executes the Observable and adds its disposable to shared, automatically disposed, composite disposable.
io.reactivex.disposables.CompositeDisposable	getDisposables()

Method Detail

getDisposables

@NotNull
io.reactivex.disposables.CompositeDisposable getDisposables()

execute

@NotNull
<T> io.reactivex.disposables.Disposable execute(@NotNull
                                                         ObservableUseCase<kotlin.Unit,T> $receiver,
                                                         @NotNull
                                                         kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.ObservableUseCaseConfig.Builder<T>,kotlin.Unit> config)

Executes the use case and adds its disposable to shared, automatically disposed, composite disposable. In case some variant of ObservableUseCase.execute method has already been called on this instance of class ObservableUseCase, previous one is disposed, no matter what current state of internal Observable is. This behavior can be disabled by passing false to ObservableUseCaseConfig.disposePrevious method.

Parameters:

config - ObservablerConfig used to process results of internal Observable.

Returns:

disposable of internal Observable. This disposable is disposed automatically. It might be used to dispose use case when you need to dispose it in advance on your own.

See Also:

ObservableUseCase.execute, class ObservableUseCase

execute

@NotNull
<ARGS,T> io.reactivex.disposables.Disposable execute(@NotNull
                                                              ObservableUseCase<ARGS,T> $receiver,
                                                              ARGS args,
                                                              @NotNull
                                                              kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.ObservableUseCaseConfig.Builder<T>,kotlin.Unit> config)

Executes the use case and adds its disposable to shared, automatically disposed, composite disposable. In case some variant of ObservableUseCase.execute method has already been called on this instance of class ObservableUseCase, previous one is disposed, no matter what current state of internal Observable is. This behavior can be disabled by passing false to ObservableUseCaseConfig.disposePrevious method.

Parameters:

args - Arguments used for initial use case initialisation.

config - class ObservableUseCaseConfig used to process results of internal Observable.

Returns:

disposable of internal Observable. This disposable is disposed automatically. It might be used to dispose use case when you need to dispose it in advance on your own.

See Also:

ObservableUseCase.execute, class ObservableUseCase

executeStream

@NotNull
<T> io.reactivex.disposables.Disposable executeStream(@NotNull
                                                               io.reactivex.Observable<T> $receiver,
                                                               @NotNull
                                                               kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.ObservableUseCaseConfig.Builder<T>,kotlin.Unit> config)

Executes the Observable and adds its disposable to shared, automatically disposed, composite disposable.

Parameters:

config - class ObservableUseCaseConfig used to process results of internal Observable.

Returns:

disposable of internal Observable. It might be used to dispose use case when you need to dispose it in advance on your own.