easymvp.usecase

Class UseCase<P,Q>

java.lang.Object

easymvp.usecase.UseCase<P,Q>

Type Parameters:

P - The response type of a use case.

Q - The request type of a use case.

Direct Known Subclasses:

CompletableUseCase, ObservableUseCase

public abstract class UseCase<P,Q>
extends java.lang.Object

Each UseCase of the system orchestrate the flow of data to and from the entities.

Outer layers of system can execute use cases by calling execute(Object)} method. Also you can use useCaseExecutor to execute the job in a background thread and postExecutionThread to post the result to another thread(usually UI thread).

Constructor Summary

Constructors

Constructor and Description
UseCase(UseCaseExecutor useCaseExecutor, PostExecutionThread postExecutionThread)

Method Summary

Modifier and Type	Method and Description
abstract P	execute(Q param) Executes use case.
rx.Scheduler	getPostExecutionThread()
rx.Scheduler	getUseCaseExecutor()
protected abstract P	interact(Q param) A hook for interacting with the given parameter(request value) and returning a response value for each concrete implementation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UseCase

public UseCase(UseCaseExecutor useCaseExecutor,
               PostExecutionThread postExecutionThread)

Method Detail

execute

public abstract P execute(@Nullable
                          Q param)

Executes use case. It should call interact(Object) to get response value.

interact

protected abstract P interact(@Nullable
                              Q param)

A hook for interacting with the given parameter(request value) and returning a response value for each concrete implementation.

It should be called inside execute(Object).

Parameters:

param - The request value.

Returns:

Returns the response value.

getUseCaseExecutor

public rx.Scheduler getUseCaseExecutor()

getPostExecutionThread

public rx.Scheduler getPostExecutionThread()