app.futured.arkitekt.rxusecases.disposables

Class MaybeDisposablesOwner.DefaultImpls

app.futured.arkitekt.rxusecases.disposables.MaybeDisposablesOwner.DefaultImpls

Enclosing interface:

MaybeDisposablesOwner

public static class MaybeDisposablesOwner.DefaultImpls

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

Method Summary

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

Method Detail

execute

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

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

Parameters:

$receiver - MayberConfig used to process results of internal Maybe.

config - MayberConfig used to process results of internal Maybe.

Returns:

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

MaybeUseCase.execute, class MaybeUseCase

execute

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

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

Parameters:

$receiver - Arguments used for initial use case initialisation.

args - class MaybeUseCaseConfig used to process results of internal Maybe.

config - class MaybeUseCaseConfig used to process results of internal Maybe.

Returns:

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

MaybeUseCase.execute, class MaybeUseCase

executeStream

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

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

Parameters:

$receiver - class MaybeUseCaseConfig used to process results of internal Maybe.

config - class MaybeUseCaseConfig used to process results of internal Maybe.

Returns:

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