org.eclipse.scada.utils.statuscodes

Class CodedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.eclipse.scada.utils.statuscodes.CodedException

All Implemented Interfaces:

Serializable, CodedExceptionBase

Direct Known Subclasses:

AuthenticationException, ConfigurationException, InvalidItemException, InvalidSessionException, NoSuchFolderException, PermissionDeniedException, UnableToCreateSessionException

public class CodedException
extends Exception
implements CodedExceptionBase

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected StatusCode	status

Constructor Summary

Constructors

Constructor and Description
CodedException(StatusCode statusCode)
CodedException(StatusCode statusCode, String message)
CodedException(StatusCode statusCode, String message, Throwable cause)
CodedException(StatusCode statusCode, Throwable cause)

Method Summary

Modifier and Type	Method and Description
String	getMessage() overrides getMessage to produce a message bearing the assigned statusCode and the the default Message of this exception type
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

Field Detail

status

protected StatusCode status

Constructor Detail

CodedException

public CodedException(StatusCode statusCode)

CodedException

public CodedException(StatusCode statusCode,
                      String message)

CodedException

public CodedException(StatusCode statusCode,
                      Throwable cause)

CodedException

public CodedException(StatusCode statusCode,
                      String message,
                      Throwable cause)

Method Detail

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 to produce a message bearing the assigned statusCode and the the default Message of this exception type

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