org.eclipse.scada.utils.statuscodes

Class CodedExceptionDefStatusCode

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.eclipse.scada.utils.statuscodes.CodedExceptionDefStatusCode

All Implemented Interfaces:

Serializable, CodedExceptionBase

public abstract class CodedExceptionDefStatusCode
extends Exception
implements CodedExceptionBase

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CodedExceptionDefStatusCode()
CodedExceptionDefStatusCode(String message)
CodedExceptionDefStatusCode(String message, Throwable cause)
CodedExceptionDefStatusCode(Throwable cause)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract StatusCode	generateStatusCode() the implementation of setStatusCode must provide the statuscode you want your exception to have.
String	getMessage()
String	getOriginalMessage() Return the original message without the status code prefix
StatusCode	getStatus() ensures that a Coded Exception has a StatusCode that is accessible

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

Constructor Detail

CodedExceptionDefStatusCode

public CodedExceptionDefStatusCode()

CodedExceptionDefStatusCode

public CodedExceptionDefStatusCode(String message)

CodedExceptionDefStatusCode

public CodedExceptionDefStatusCode(Throwable cause)

CodedExceptionDefStatusCode

public CodedExceptionDefStatusCode(String message,
                           Throwable cause)

Method Detail

generateStatusCode

protected abstract StatusCode generateStatusCode()

the implementation of setStatusCode must provide the statuscode you want your exception to have. either get it from the local statusCode file (StatusCodes) or create a new statusCode (new StatusCode()).

getStatus

public StatusCode getStatus()

Description copied from interface: CodedExceptionBase

ensures that a Coded Exception has a StatusCode that is accessible

Specified by:

getStatus in interface CodedExceptionBase

Returns:

String of StatusCode

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getOriginalMessage

public String getOriginalMessage()

Description copied from interface: CodedExceptionBase

Return the original message without the status code prefix

Specified by:

getOriginalMessage in interface CodedExceptionBase

Returns:

the original message