Package io.simplesource.api

Class CommandError

java.lang.Object

io.simplesource.api.CommandError

public 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	Description
static class	CommandError.Reason

Method Summary

Modifier and Type	Method	Description
String	getMessage()	The error message accessor
CommandError.Reason	getReason()	The reason value accessor.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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 accessor.

Returns:

the reason

getMessage

public String getMessage()

The error message accessor

Returns:

the error message