com.motivewave.platform.sdk.common

Class MException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.motivewave.platform.sdk.common.MException

All Implemented Interfaces:

java.io.Serializable

public class MException
extends java.lang.Exception

General Exception class

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MException(ErrorCode error) Constructs a new MException using the given error code.
MException(ErrorCode error, java.lang.Object... parameters) Constructs a new MException with the given error code and parameter substitution for the message.
MException(java.lang.Exception cause, ErrorCode error) Constructs a new MException with the cause and error msg.
MException(java.lang.Exception cause, ErrorCode error, java.lang.Object... parameters) Constructs a new MException with the cause, using the error.

Method Summary

Methods

Modifier and Type	Method and Description
ErrorCode	getErrorCode() Gets the error code associated with this exception.
java.lang.String	getMessage() Gets the locale dependent message for this exception.
java.lang.String	getMessage(java.util.Locale locale) Gets the exception message in the given locale (if a translation is available).
java.lang.Object[]	getParameters() Gets the exception parameters.
java.lang.Object	getSource() Gets the source object that generated this exception.
boolean	isError(ErrorCode error) Compares the internal error code with the given error code and returns true if they are equal.
void	setSource(java.lang.Object src) Sets the source object that generated this exception.

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

MException

public MException(ErrorCode error)

Constructs a new MException using the given error code.

Parameters:

error - error code for the exception

MException

public MException(ErrorCode error,
          java.lang.Object... parameters)

Constructs a new MException with the given error code and parameter substitution for the message.

Parameters:

error - the error code

parameters - substitution parameters for the error message

MException

public MException(java.lang.Exception cause,
          ErrorCode error)

Constructs a new MException with the cause and error msg.

Parameters:

cause - the cause

error - error code

MException

public MException(java.lang.Exception cause,
          ErrorCode error,
          java.lang.Object... parameters)

Constructs a new MException with the cause, using the error. The given parameters will be substituted into the message.

Parameters:

cause - the cause

error - error code

parameters - substitution parameters

Method Detail

getErrorCode

public ErrorCode getErrorCode()

Gets the error code associated with this exception.

Returns:

error code for this exception

getSource

public java.lang.Object getSource()

Gets the source object that generated this exception.

Returns:

source of this exception

setSource

public void setSource(java.lang.Object src)

Sets the source object that generated this exception.

Parameters:

src - source of this exception

getParameters

public java.lang.Object[] getParameters()

Gets the exception parameters.

Returns:

exception parameters

getMessage

public java.lang.String getMessage()

Gets the locale dependent message for this exception.

Overrides:

getMessage in class java.lang.Throwable

Returns:

locale dependent message

getMessage

public java.lang.String getMessage(java.util.Locale locale)

Gets the exception message in the given locale (if a translation is available).

Parameters:

locale - locale for the message

Returns:

exception message in the given locale (if a translation is available).

isError

public boolean isError(ErrorCode error)

Compares the internal error code with the given error code and returns true if they are equal.

Parameters:

error - error code

Returns:

true if the error codes are the same, false otherwise