Package io.github.juliengalet.reactorflow.exception

Class FlowException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.github.juliengalet.reactorflow.exception.FlowException

All Implemented Interfaces:

PrettyPrint, Serializable

Direct Known Subclasses:

FlowBuilderException, FlowFunctionalException, FlowTechnicalException

public abstract class FlowException
extends RuntimeException
implements PrettyPrint

Abstract exception used to generate all types of exceptions used in this library. You can inherit this class to build custom exceptions if you want.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FlowException(String message)	Construct an exception from a message.
protected	FlowException(Throwable cause, String message)	Construct an exception from a message and the original Throwable.

Method Summary

Modifier and Type	Method	Description
FlowException	flowConcerned(Flow<?> flowConcerned)	Set the flowConcerned.
Flow<?>	getFlowConcerned()	Get the flowConcerned.
abstract FlowExceptionType	getType()	Abstract method that should be implemented, in order to know the FlowExceptionType.
boolean	isRecoverable(RecoverableFlowException recoverable)	Check if the exception is recoverable or retryable, for a RecoverableFlowException type.
String	toPrettyString()	Get the colorized string representation of the exception.
String	toString()	Get the string representation of the exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowException

protected FlowException(String message)

Construct an exception from a message.

Parameters:

message - The message

FlowException

protected FlowException(Throwable cause,
                        String message)

Construct an exception from a message and the original Throwable.

Parameters:

cause - The original Throwable

message - The message

Method Detail

getType

public abstract FlowExceptionType getType()

Abstract method that should be implemented, in order to know the FlowExceptionType.

Returns:

A FlowExceptionType

flowConcerned

public FlowException flowConcerned(Flow<?> flowConcerned)

Set the flowConcerned.

Parameters:

flowConcerned - The flowConcerned

Returns:

The FlowException

getFlowConcerned

public Flow<?> getFlowConcerned()

Get the flowConcerned.

Returns:

A Flow or null.

toString

public String toString()

Get the string representation of the exception.

Overrides:

toString in class Throwable

Returns:

A String representing the exception

toPrettyString

public String toPrettyString()

Get the colorized string representation of the exception.

Specified by:

toPrettyString in interface PrettyPrint

Returns:

A String representing the exception

isRecoverable

public final boolean isRecoverable(RecoverableFlowException recoverable)

Check if the exception is recoverable or retryable, for a RecoverableFlowException type.

Parameters:

recoverable - A RecoverableFlowException type

Returns:

A boolean