io.simplesource.data

Interface Error<Reason>

All Known Implementing Classes:

Error.StringError, Error.ThrowableError

public interface Error<Reason>

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	Interface and Description
static class	Error.StringError<Reason>
static class	Error.ThrowableError<Reason>

Method Summary

Modifier and Type	Method and Description
String	getMessage() The reason message accessor
Reason	getReason() The reason value accessor.
static <Reason> Error<Reason>	of(Reason reason, String msg) Construct a Error from a Throwable.
static <Reason> Error<Reason>	of(Reason reason, Throwable throwable) Construct a Error from a Throwable.

Method Detail

of

static <Reason> Error<Reason> of(Reason reason,
                                 Throwable throwable)

Construct a Error from a Throwable.

Parameters:

reason - the reason value

throwable - for more context

Returns:

the constructed Error

of

static <Reason> Error<Reason> of(Reason reason,
                                 String msg)

Construct a Error from a Throwable.

Parameters:

reason - the reason value

msg - for more context

Returns:

the constructed Error

getReason

Reason getReason()

The reason value accessor.

Returns:

the reason

getMessage

String getMessage()

The reason message accessor

Returns:

the reason message