app.futured.arkitekt.rxusecases.disposables

Interface CompletableDisposablesOwner

All Known Subinterfaces:

DisposablesOwner

All Known Implementing Classes:

BaseRxViewModel

public CompletableDisposablesOwner

This interface gives your class ability to execute class CompletableUseCase 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 CompletableUseCase, interface DisposablesOwner

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CompletableDisposablesOwner.DefaultImpls This interface gives your class ability to execute class CompletableUseCase 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
io.reactivex.disposables.Disposable	execute(CompletableUseCase<kotlin.Unit> $receiver, kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.CompletableUseCaseConfig.Builder,kotlin.Unit> config) Executes the use case and adds its disposable to shared, automatically disposed, composite disposable. In case some variant of CompletableUseCase.execute method has already been called on this instance of class CompletableUseCase, previous one is disposed, no matter what current state of internal Completable is. This behavior can be disabled by passing false to CompletableUseCaseConfig.disposePrevious method.
<ARGS> io.reactivex.disposables.Disposable	execute(CompletableUseCase<ARGS> $receiver, ARGS args, kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.CompletableUseCaseConfig.Builder,kotlin.Unit> config) Executes the use case and adds its disposable to shared, automatically disposed, composite disposable. In case some variant of CompletableUseCase.execute method has already been called on this instance of class CompletableUseCase, previous one is disposed, no matter what current state of internal Completable is. This behavior can be disabled by passing false to CompletableUseCaseConfig.disposePrevious method.
io.reactivex.disposables.Disposable	executeStream(io.reactivex.Completable $receiver, kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.CompletableUseCaseConfig.Builder,kotlin.Unit> config) Executes the Completable 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
io.reactivex.disposables.Disposable execute(@NotNull
                                                     CompletableUseCase<kotlin.Unit> $receiver,
                                                     @NotNull
                                                     kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.CompletableUseCaseConfig.Builder,kotlin.Unit> config)

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

Parameters:

config - CompletablerConfig used to process results of internal Completable.

Returns:

disposable of internal Completable. 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:

CompletableUseCase.execute, class CompletableUseCase

execute

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

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

Parameters:

args - Arguments used for initial use case initialisation.

config - class CompletableUseCaseConfig used to process results of internal Completable.

Returns:

disposable of internal Completable. 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:

CompletableUseCase.execute, class CompletableUseCase

executeStream

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

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

Parameters:

config - class CompletableUseCaseConfig used to process results of internal Completable.

Returns:

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