Skip navigation links
A B C D E F G H L M O R S T U 

A

app.futured.arkitekt.crusecases - package app.futured.arkitekt.crusecases
 
app.futured.arkitekt.crusecases.utils - package app.futured.arkitekt.crusecases.utils
 

B

BaseCrViewModel<S extends ViewState> - Class in app.futured.arkitekt.crusecases
Base ViewModel class prepared for providing data to UI through LiveData and obtaining data from Stores (Repositories) by executing Coroutine based use cases like class UseCase and class FlowUseCase.
BaseCrViewModel() - Constructor for class app.futured.arkitekt.crusecases.BaseCrViewModel
Base ViewModel class prepared for providing data to UI through LiveData and obtaining data from Stores (Repositories) by executing Coroutine based use cases like class UseCase and class FlowUseCase.
build() - Method in class app.futured.arkitekt.crusecases.FlowUseCaseConfig.Builder
 
build() - Method in class app.futured.arkitekt.crusecases.UseCaseConfig.Builder
 
build(args) - Method in class app.futured.arkitekt.crusecases.FlowUseCase
Function which builds Flow instance based on given arguments
build(args, p) - Method in class app.futured.arkitekt.crusecases.UseCase
Suspend function which should contain business logic
Builder() - Constructor for class app.futured.arkitekt.crusecases.FlowUseCaseConfig.Builder
Constructs references to lambdas and some basic configuration used to process results of Flow use case.
Builder() - Constructor for class app.futured.arkitekt.crusecases.UseCaseConfig.Builder
Constructs references to lambdas and some basic configuration used to process results of Coroutine use case.

C

component1() - Method in class app.futured.arkitekt.crusecases.Result
 
component2() - Method in class app.futured.arkitekt.crusecases.Result
 
CoroutineScopeOwner - Interface in app.futured.arkitekt.crusecases
This interface gives your class ability to execute class UseCase and class FlowUseCase Coroutine use cases. You may find handy to implement this interface in custom Presenters, ViewHolders etc. It is your responsibility to cancel coroutineScope when when all running tasks should be stopped.
CoroutineScopeOwner.DefaultImpls - Class in app.futured.arkitekt.crusecases
This interface gives your class ability to execute class UseCase and class FlowUseCase Coroutine use cases. You may find handy to implement this interface in custom Presenters, ViewHolders etc. It is your responsibility to cancel coroutineScope when when all running tasks should be stopped.
CoroutineScopeOwner.FlowUseCaseConfig<T> - Class in app.futured.arkitekt.crusecases
Holds references to lambdas and some basic configuration used to process results of Flow use case. Use class FlowUseCaseConfig.Builder to construct this object.
CoroutineScopeOwner.UseCaseConfig<T> - Class in app.futured.arkitekt.crusecases
Holds references to lambdas and some basic configuration used to process results of Coroutine use case. Use class UseCaseConfig.Builder to construct this object.

D

defaultErrorHandler(exception) - Method in interface app.futured.arkitekt.crusecases.CoroutineScopeOwner
This method is called when coroutine launched with launchWithHandler throws an exception and this exception isn't CancellationException. By default, it rethrows this exception.
defaultErrorHandler($this, exception) - Static method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.DefaultImpls
This method is called when coroutine launched with launchWithHandler throws an exception and this exception isn't CancellationException. By default, it rethrows this exception.
disposePrevious(disposePrevious) - Method in class app.futured.arkitekt.crusecases.FlowUseCaseConfig.Builder
Set whether currently running Job of internal Flow should be canceled when execute is called repeatedly.
disposePrevious(disposePrevious) - Method in class app.futured.arkitekt.crusecases.UseCaseConfig.Builder
Set whether currently active Job of internal Coroutine should be canceled when execute is called repeatedly. Default value is true.

E

equals(other) - Method in class app.futured.arkitekt.crusecases.Error
 
equals(other) - Method in class app.futured.arkitekt.crusecases.Success
 
Error - Class in app.futured.arkitekt.crusecases
Represents a failed class Result, containing an error.
Error(error) - Constructor for class app.futured.arkitekt.crusecases.Error
Represents a failed class Result, containing an error.
execute($this, $receiver, config) - Static method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.DefaultImpls
Asynchronously executes use case and saves it's Deferred. By default all previous pending executions are canceled, this can be changed by the config. This version is used for use cases without initial arguments.
execute($this, $receiver, args, config) - Static method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.DefaultImpls
Asynchronously executes use case and saves it's Deferred. By default all previous pending executions are canceled, this can be changed by the config. This version gets initial arguments by args.
execute($this, $receiver, cancelPrevious, p) - Static method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.DefaultImpls
Synchronously executes use case and saves it's Deferred. By default all previous pending executions are canceled, this can be changed by the cancelPrevious. This version is used for use cases without initial arguments.
execute($this, $receiver, args, cancelPrevious, p) - Static method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.DefaultImpls
Synchronously executes use case and saves it's Deferred. By default all previous pending executions are canceled, this can be changed by the cancelPrevious. This version gets initial arguments by args.
execute($this, $receiver, config) - Static method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.DefaultImpls
 
execute($this, $receiver, args, config) - Static method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.DefaultImpls
Asynchronously executes use case and consumes data from flow on UI thread. By default all previous pending executions are canceled, this can be changed by config. When suspend function in use case finishes, onComplete is called on UI thread. This version is gets initial arguments by args.
execute($receiver, config) - Method in interface app.futured.arkitekt.crusecases.CoroutineScopeOwner
Asynchronously executes use case and saves it's Deferred. By default all previous pending executions are canceled, this can be changed by the config. This version is used for use cases without initial arguments.
execute($receiver, args, config) - Method in interface app.futured.arkitekt.crusecases.CoroutineScopeOwner
Asynchronously executes use case and saves it's Deferred. By default all previous pending executions are canceled, this can be changed by the config. This version gets initial arguments by args.
execute($receiver, cancelPrevious, p) - Method in interface app.futured.arkitekt.crusecases.CoroutineScopeOwner
Synchronously executes use case and saves it's Deferred. By default all previous pending executions are canceled, this can be changed by the cancelPrevious. This version is used for use cases without initial arguments.
execute($receiver, args, cancelPrevious, p) - Method in interface app.futured.arkitekt.crusecases.CoroutineScopeOwner
Synchronously executes use case and saves it's Deferred. By default all previous pending executions are canceled, this can be changed by the cancelPrevious. This version gets initial arguments by args.
execute($receiver, config) - Method in interface app.futured.arkitekt.crusecases.CoroutineScopeOwner
 
execute($receiver, args, config) - Method in interface app.futured.arkitekt.crusecases.CoroutineScopeOwner
Asynchronously executes use case and consumes data from flow on UI thread. By default all previous pending executions are canceled, this can be changed by config. When suspend function in use case finishes, onComplete is called on UI thread. This version is gets initial arguments by args.

F

FlowUseCase<ARGS,T> - Class in app.futured.arkitekt.crusecases
Base Flow use case meant to use in interface CoroutineScopeOwner implementations
FlowUseCase() - Constructor for class app.futured.arkitekt.crusecases.FlowUseCase
Base Flow use case meant to use in interface CoroutineScopeOwner implementations
FlowUseCaseConfig.Builder<T> - Class in app.futured.arkitekt.crusecases
Constructs references to lambdas and some basic configuration used to process results of Flow use case.
fold($receiver, onSuccess, onError) - Static method in class app.futured.arkitekt.crusecases.ResultKt
Returns the the result of onSuccess for encapsulated value if this instance represents class Success or the result of onError function for encapsulated exception if it is class Error.

G

getCoroutineScope() - Method in class app.futured.arkitekt.crusecases.BaseCrViewModel
CoroutineScope scope used to execute coroutine based use cases. It is your responsibility to cancel it when all running tasks should be stopped
getCoroutineScope() - Method in interface app.futured.arkitekt.crusecases.CoroutineScopeOwner
CoroutineScope scope used to execute coroutine based use cases. It is your responsibility to cancel it when all running tasks should be stopped
getDeferred() - Method in class app.futured.arkitekt.crusecases.UseCase
Deferred used to hold and cancel existing run of this use case
getDisposePrevious() - Method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.FlowUseCaseConfig
 
getDisposePrevious() - Method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.UseCaseConfig
 
getError() - Method in class app.futured.arkitekt.crusecases.Error
 
getJob() - Method in class app.futured.arkitekt.crusecases.FlowUseCase
Job used to hold and cancel existing run of this use case
getOnComplete() - Method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.FlowUseCaseConfig
 
getOnError() - Method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.FlowUseCaseConfig
 
getOnError() - Method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.UseCaseConfig
 
getOnNext() - Method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.FlowUseCaseConfig
 
getOnStart() - Method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.FlowUseCaseConfig
 
getOnStart() - Method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.UseCaseConfig
 
getOnSuccess() - Method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.UseCaseConfig
 
getOrCancel($receiver, doBeforeThrow) - Static method in class app.futured.arkitekt.crusecases.ResultKt
Returns the encapsulated value if this instance represents class Success or throws CancellationException with Error.error as its cause if it is class Error.
getOrDefault($receiver, defaultValue) - Static method in class app.futured.arkitekt.crusecases.ResultKt
Returns the encapsulated value if this instance represents class Success or defaultValue for encapsulated exception if it is class Error.
getOrElse($receiver, onError) - Static method in class app.futured.arkitekt.crusecases.ResultKt
Returns the encapsulated value if this instance represents class Success or result of onError for encapsulated exception if it is class Error.
getOrNull($receiver) - Static method in class app.futured.arkitekt.crusecases.ResultKt
Returns the encapsulated value if this instance represents class Success or null for encapsulated exception if it is class Error.
getOrThrow($receiver, doBeforeThrow) - Static method in class app.futured.arkitekt.crusecases.ResultKt
Returns the encapsulated value if this instance represents class Success or throws the encapsulated exception if it is class Error.
getRootCause($receiver) - Static method in class app.futured.arkitekt.crusecases.utils.ThrowableExtensionsKt
Returns a root cause of this exception or null if there is no
getValue() - Method in class app.futured.arkitekt.crusecases.Success
 
getWorkerDispatcher($this) - Static method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.DefaultImpls
Provides Dispatcher for background tasks. This may be overridden for testing purposes
getWorkerDispatcher() - Method in interface app.futured.arkitekt.crusecases.CoroutineScopeOwner
Provides Dispatcher for background tasks. This may be overridden for testing purposes

H

hashCode() - Method in class app.futured.arkitekt.crusecases.Error
 
hashCode() - Method in class app.futured.arkitekt.crusecases.Success
 

L

launchWithHandler($this, block) - Static method in class app.futured.arkitekt.crusecases.CoroutineScopeOwner.DefaultImpls
Launch suspend block in coroutineScope. Encapsulates this call with try catch block and when an exception is thrown then it is logged in UseCaseErrorHandler.globalOnErrorLogger and handled by defaultErrorHandler.
launchWithHandler(block) - Method in interface app.futured.arkitekt.crusecases.CoroutineScopeOwner
Launch suspend block in coroutineScope. Encapsulates this call with try catch block and when an exception is thrown then it is logged in UseCaseErrorHandler.globalOnErrorLogger and handled by defaultErrorHandler.

M

map($receiver, transform) - Static method in class app.futured.arkitekt.crusecases.ResultKt
Returns the encapsulated result of the given transform function applied to encapsulated value if this instance represents class Success or the original encapsulated exception if it is class Error.
mapCatching($receiver, transform) - Static method in class app.futured.arkitekt.crusecases.ResultKt
Returns the encapsulated result of the given transform function applied to encapsulated value if this instance represents class Success or the original encapsulated exception if it is class Error.

O

onComplete(onComplete) - Method in class app.futured.arkitekt.crusecases.FlowUseCaseConfig.Builder
Set lambda that is called when internal Flow is completed without errors
onError(onError) - Method in class app.futured.arkitekt.crusecases.FlowUseCaseConfig.Builder
Set lambda that is called when some exception on internal Flow occurs
onError(onError) - Method in class app.futured.arkitekt.crusecases.UseCaseConfig.Builder
Set lambda that is called when exception on internal Coroutine occurs
onNext(onNext) - Method in class app.futured.arkitekt.crusecases.FlowUseCaseConfig.Builder
Set lambda that is called when internal Flow emits new value
onStart(onStart) - Method in class app.futured.arkitekt.crusecases.FlowUseCaseConfig.Builder
Set lambda that is called right before internal Job of Flow is launched.
onStart(onStart) - Method in class app.futured.arkitekt.crusecases.UseCaseConfig.Builder
Set lambda that is called right before the internal Coroutine is created
onSuccess(onSuccess) - Method in class app.futured.arkitekt.crusecases.UseCaseConfig.Builder
Set lambda that is called when internal Coroutine finished without exceptions

R

recover($receiver, transform) - Static method in class app.futured.arkitekt.crusecases.ResultKt
Returns the encapsulated result of the given transform function applied to encapsulated exception if this instance represents class Error or the original encapsulated value if it is class Success.
recoverCatching($receiver, transform) - Static method in class app.futured.arkitekt.crusecases.ResultKt
Returns the encapsulated result of the given transform function applied to encapsulated exception if this instance represents class Error or the original encapsulated value if it is class Success.
Result<VALUE> - Class in app.futured.arkitekt.crusecases
A discriminated union that encapsulates successful outcome either with class Success or with class Error
ResultKt - Class in app.futured.arkitekt.crusecases
 

S

setDeferred(p) - Method in class app.futured.arkitekt.crusecases.UseCase
Deferred used to hold and cancel existing run of this use case
setJob(p) - Method in class app.futured.arkitekt.crusecases.FlowUseCase
Job used to hold and cancel existing run of this use case
Success<VALUE> - Class in app.futured.arkitekt.crusecases
Represents a successful class Result, containing a value.
Success(value) - Constructor for class app.futured.arkitekt.crusecases.Success
Represents a successful class Result, containing a value.

T

ThrowableExtensionsKt - Class in app.futured.arkitekt.crusecases.utils
 
toString() - Method in class app.futured.arkitekt.crusecases.Result
 
tryCatch(block) - Static method in class app.futured.arkitekt.crusecases.ResultKt
Calls the specified function block and returns class Success with encapsulated result if invocation was successful, catching and returning class Error with any thrown exception except CancellationException.

U

UseCase<ARGS,T> - Class in app.futured.arkitekt.crusecases
Base Coroutine use case meant to use in interface CoroutineScopeOwner implementations
UseCase() - Constructor for class app.futured.arkitekt.crusecases.UseCase
Base Coroutine use case meant to use in interface CoroutineScopeOwner implementations
UseCaseConfig.Builder<T> - Class in app.futured.arkitekt.crusecases
Constructs references to lambdas and some basic configuration used to process results of Coroutine use case.
A B C D E F G H L M O R S T U 
Skip navigation links