reactivecircus.blueprint.interactor.rx2.CompletableInteractor.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blueprint-interactor-rx2 Show documentation

Interactors (use case in Clean Architecture) based on RxJava 2

There is a newer version: 1.18.0

Show newest version

package reactivecircus.blueprint.interactor.rx2

import io.reactivex.Completable
import io.reactivex.Scheduler
import reactivecircus.blueprint.interactor.InteractorParams

/**
 * Abstract class for a use case, representing an execution unit of asynchronous work.
 * This use case type uses [Completable] as the return type.
 * Upon subscription a use case will execute its job in the thread specified by the [ioScheduler].
 * and will post the result to the thread specified by [uiScheduler].
 */
public abstract class CompletableInteractor(
    private val ioScheduler: Scheduler,
    private val uiScheduler: Scheduler
) {

    /**
     * Create a [Completable] for this interactor.
     */
    protected abstract fun createInteractor(params: P): Completable

    /**
     * Build a use case with the provided execution thread and post execution thread
     */
    public fun buildCompletable(params: P): Completable {
        return createInteractor(params)
            .subscribeOn(ioScheduler)
            .observeOn(uiScheduler)
    }
}