digital.bakehouse.rxusecase.decorator

Class FailureConverter

java.lang.Object

digital.bakehouse.rxusecase.decorator.FailureConverter

All Implemented Interfaces:

UseCaseDecorator

public final class FailureConverter
extends java.lang.Object
implements UseCaseDecorator

Decorator that maps exceptions thrown by decorated use-cases to Failure objects. FailureException will always get mapped to a Failure. If an exceptionMapper is defined, it will be used to map all the other exceptions. Otherwise (or if it returns null failure for an exception) the exception will be propagated down the stream.

Method Summary

Modifier and Type	Method and Description
<I,O> io.reactivex.Observable<Response<O>>	decorate(io.reactivex.Observable<Response<O>> origin, Request<I> ignored) Decorate the passed observable stream with additional functionality.
static FailureConverter	get(digital.bakehouse.rxusecase.decorator.FailureConverter.Mapper exceptionToFailureMapper) Factory method to create a converter which converts the exceptions emitted by the decorated use-cases into Failure objects using the passed mapper.
static FailureConverter	getDefault() Factory method to create a converter which converts only instances of the FailureException into Failure objects and propagates the other exception types does the stream.
static FailureConverter	getWithFallback(Failure fallbackFailure) Factory method to create a converter which converts all exceptions emitted by the decorated use-cases to Failure objects: - FailureException to their respective Failure objects - any other exception to the passed fallback Failure

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public static FailureConverter getDefault()

Factory method to create a converter which converts only instances of the FailureException into Failure objects and propagates the other exception types does the stream.

Returns:

Default failure converter

get

public static FailureConverter get(digital.bakehouse.rxusecase.decorator.FailureConverter.Mapper exceptionToFailureMapper)

Factory method to create a converter which converts the exceptions emitted by the decorated use-cases into Failure objects using the passed mapper.

Parameters:

exceptionToFailureMapper - Exception mapper

Returns:

Mapping failure converter

getWithFallback

public static FailureConverter getWithFallback(Failure fallbackFailure)

Factory method to create a converter which converts all exceptions emitted by the decorated use-cases to Failure objects: - FailureException to their respective Failure objects - any other exception to the passed fallback Failure

Parameters:

fallbackFailure - Fallback failure

Returns:

Fallback converter

decorate

public final <I,O> io.reactivex.Observable<Response<O>> decorate(io.reactivex.Observable<Response<O>> origin,
                                                                 Request<I> ignored)

Description copied from interface: UseCaseDecorator

Decorate the passed observable stream with additional functionality.

Specified by:

decorate in interface UseCaseDecorator

Type Parameters:

I - Input type

O - Output type

Parameters:

origin - Observable stream to decorate

ignored - Request object

Returns:

Decorated observable stream