app.futured.arkitekt.rxusecases.disposables

Class SingleDisposablesOwner.DefaultImpls

app.futured.arkitekt.rxusecases.disposables.SingleDisposablesOwner.DefaultImpls

Enclosing interface:

SingleDisposablesOwner

public static class SingleDisposablesOwner.DefaultImpls

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

Method Summary

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

Method Detail

execute

@NotNull
public static <T> io.reactivex.disposables.Disposable execute(SingleDisposablesOwner $this,
                                                                       @NotNull
                                                                       SingleUseCase<kotlin.Unit,T> $receiver,
                                                                       @NotNull
                                                                       kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.SingleUseCaseConfig.Builder<T>,kotlin.Unit> config)

Executes the use case and adds its disposable to shared, automatically disposed, composite disposable. In case some variant of SingleUseCase.execute method has already been called on this instance of class SingleUseCase, previous one is disposed, no matter what current state of internal Single is. Use Single.executeStream if you want to run one class SingleUseCase multiple times simultaneously. This behavior can be disabled by passing false to SingleUseCaseConfig.disposePrevious method.

Parameters:

$receiver - SinglerConfig used to process results of internal Single.

config - SinglerConfig used to process results of internal Single.

Returns:

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

SingleUseCase.execute, class SingleUseCase, Single.executeStream, class SingleUseCase

execute

@NotNull
public static <ARGS,T> io.reactivex.disposables.Disposable execute(SingleDisposablesOwner $this,
                                                                            @NotNull
                                                                            SingleUseCase<ARGS,T> $receiver,
                                                                            ARGS args,
                                                                            @NotNull
                                                                            kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.SingleUseCaseConfig.Builder<T>,kotlin.Unit> config)

Executes the use case and adds its disposable to shared, automatically disposed, composite disposable. In case some variant of SingleUseCase.execute method has already been called on this instance of class SingleUseCase, previous one is disposed, no matter what current state of internal Single is. Use Single.executeStream if you want to run one class SingleUseCase multiple times simultaneously. This behavior can be disabled by passing false to SingleUseCaseConfig.disposePrevious method.

Parameters:

$receiver - Arguments used for initial use case initialization.

args - class SingleUseCaseConfig used to process results of internal Single.

config - class SingleUseCaseConfig used to process results of internal Single.

Returns:

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

SingleUseCase.execute, class SingleUseCase, Single.executeStream, class SingleUseCase

executeStream

@NotNull
public static <T> io.reactivex.disposables.Disposable executeStream(SingleDisposablesOwner $this,
                                                                             @NotNull
                                                                             io.reactivex.Single<T> $receiver,
                                                                             @NotNull
                                                                             kotlin.jvm.functions.Function1<? super app.futured.arkitekt.rxusecases.disposables.SingleUseCaseConfig.Builder<T>,kotlin.Unit> config)

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

Parameters:

$receiver - class SingleUseCaseConfig used to process results of internal Single.

config - class SingleUseCaseConfig used to process results of internal Single.

Returns:

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