Package nz.org.riskscape.engine.cli

Class ExitException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

nz.org.riskscape.engine.RiskscapeException

nz.org.riskscape.engine.cli.ExitException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InvalidUsageException, ReadlineInterruptedException

public class ExitException
extends RiskscapeException

Throw when there is some issue with the command that deserves an error message to the user along with potentially a non-zero exit

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Problem	NO_PROBLEM	Magic problem that indicates that there wasn't a problem related to this exit exception, such as when the user just wants to quit

Constructor Summary

Constructors

Constructor	Description
ExitException(int exitCode, String message, Object... formatArgs)
ExitException(int exitCode, String message, List<Problem> problems)
ExitException(int exitCode, Throwable cause, String message, Object... formatArgs)
ExitException(int exitCode, Problem problem)
ExitException(Problem problem)
ExitException(Problem problem, Throwable cause)

Method Summary

Modifier and Type	Method	Description
static void	quit()	Throw an ExitException that will cause riskscape to exit immediately without error
ExitCode	toExitCode(Messages messages)

Methods inherited from class nz.org.riskscape.engine.RiskscapeException

getCause, getProblem, hasProblem

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Details

NO_PROBLEM

public static final Problem NO_PROBLEM

Magic problem that indicates that there wasn't a problem related to this exit exception, such as when the user just wants to quit

Constructor Details

ExitException

public ExitException(int exitCode,
 String message,
 Object... formatArgs)

ExitException

public ExitException(int exitCode,
 String message,
 List<Problem> problems)

ExitException

public ExitException(int exitCode,
 Problem problem)

ExitException

public ExitException(Problem problem)

ExitException

public ExitException(Problem problem,
 Throwable cause)

ExitException

public ExitException(int exitCode,
 Throwable cause,
 String message,
 Object... formatArgs)

Parameters:

exitCode - the exit code to exit(int) with

cause - a reason for the exit, can be null

message - a message to print out on to the command line, first argument to String.format(String, Object...)

formatArgs - parameters to interpolate in the the message, second argument to String.format(String, Object...)

Method Details

quit

public static void quit()

Throw an ExitException that will cause riskscape to exit immediately without error

toExitCode

public ExitCode toExitCode(Messages messages)