de.weltraumschaf.commons.application

Class ApplicationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

de.weltraumschaf.commons.application.ApplicationException

All Implemented Interfaces:

Serializable

public class ApplicationException
extends Exception

Used to signal abnormal exceptional application states.

If an exception if this type is thrown should cause program termination with the exit code.

Since:

1.0.0

Author:

Sven Strittmatter

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private ExitCode	exitCode Exit code used to return to JVM.

Constructor Summary

Constructors

Constructor and Description
ApplicationException(ExitCode exitCode, String message) Initializes the cause with null.
ApplicationException(ExitCode exitCode, String message, Throwable cause) Dedicated constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ExitCode	getExitCode() Get program exit code.
String	toString()

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

Field Detail

exitCode

private final ExitCode exitCode

Exit code used to return to JVM.

Constructor Detail

ApplicationException

public ApplicationException(ExitCode exitCode,
                    String message)

Initializes the cause with null.

Parameters:

exitCode - must not be null

message - must not be null or empty

ApplicationException

public ApplicationException(ExitCode exitCode,
                    String message,
                    Throwable cause)

Dedicated constructor.

Parameters:

exitCode - must not be null

message - must not be null or empty

cause - may be null

Method Detail

getExitCode

public ExitCode getExitCode()

Get program exit code.

Returns:

never null

toString

public String toString()

Overrides:

toString in class Throwable