io.simplesource.api

Class CommandError

java.lang.Object

io.simplesource.api.CommandError

public abstract class CommandError
extends Object

A CommandError explains failures. They can be constructed from the reason type, with either a String or a Throwable for more context.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandError.Reason

Method Summary

Modifier and Type	Method and Description
abstract <A> A	fold(java.util.function.BiFunction<CommandError.Reason,String,A> str, java.util.function.BiFunction<CommandError.Reason,Throwable,A> ex) Access the reason value and either the string or the throwable context and return whatever you like.
abstract String	getMessage() The reason message acaessor
CommandError.Reason	getReason() The reason value acaessor
static CommandError	of(CommandError.Reason reason, String msg) Construct a CommandError from a Throwable
static CommandError	of(CommandError.Reason reason, Throwable throwable) Construct a CommandError from a Throwable
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static CommandError of(CommandError.Reason reason,
                              Throwable throwable)

Construct a CommandError from a Throwable

Parameters:

reason - the reason value

throwable - for more context

Returns:

the constructed CommandError

of

public static CommandError of(CommandError.Reason reason,
                              String msg)

Construct a CommandError from a Throwable

Parameters:

reason - the reason value

msg - for more context

Returns:

the constructed CommandError

getReason

public CommandError.Reason getReason()

The reason value acaessor

Returns:

the reason

getMessage

public abstract String getMessage()

The reason message acaessor

Returns:

the reason message

fold

public abstract <A> A fold(java.util.function.BiFunction<CommandError.Reason,String,A> str,
                           java.util.function.BiFunction<CommandError.Reason,Throwable,A> ex)

Access the reason value and either the string or the throwable context and return whatever you like.

Type Parameters:

A - the result type

Parameters:

str - the function that receives the reason and string, returning a value of the specified type

ex - the function that receives the reason and throwable, returning a value of the specified type

Returns:

the result

toString

public String toString()

Overrides:

toString in class Object