com.whitestein.lsps.common

Class ErrorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.whitestein.lsps.common.LspsException

com.whitestein.lsps.common.ErrorException

All Implemented Interfaces:

IErrorException, ILspsException, Serializable

Direct Known Subclasses:

FlywayErrorException, WrappingErrorException, XmlParsingException, XmlProcessingException

public class ErrorException
extends LspsException
implements IErrorException

This exception represents a BPMN error. It has an error code and can contain several contexts in order to better localize the exception source which appear at the end of the exception message.

Author:

rba

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODEL_CONTEXT Key for model context
static String	MODEL_INSTANCE_CONTEXT Key for model instance context

Constructor Summary

Constructors

Constructor and Description
ErrorException(ErrorRuntimeException e) Creates new instance.
ErrorException(ErrorRuntimeException e, String[] stackTraceInfo) Creates new instance.
ErrorException(String errorCode) Creates new instance.
ErrorException(String errorCode, String message) Creates new instance.
ErrorException(String errorCode, String[] stackTraceInfo) Creates new instance.
ErrorException(String errorCode, String message, String[] stackTraceInfo) Creates new instance.
ErrorException(String errorCode, String message, String[] stackTraceInfo, String contextId, String context) Creates new instance.
ErrorException(String errorCode, String message, Throwable cause) Creates new instance.
ErrorException(String errorCode, String message, Throwable cause, String[] stackTraceInfo) Creates new instance.
ErrorException(String errorCode, Throwable cause) Creates new instance.
ErrorException(String errorCode, Throwable cause, String[] stackTraceInfo) Creates new instance.
ErrorException(String errorCode, Throwable cause, String contextId, String context) Creates new instance.
ErrorException(String errorCode, Throwable cause, String contextId, String context, String[] stackTraceInfo) Creates new instance.

Method Summary

Modifier and Type	Method and Description
void	addContext(String contextId, String context) Adds a context.
void	addContextIfIdNotExists(String contextId, String context) Adds a context of there is no context with a given contextId already.
void	addContexts(List<ErrorContext> contexts) Adds all contexts.
void	addModelContext(long modelId) Adds context of model.
void	addModelInstanceContext(long modelInstanceId) Adds context on model instance.
ErrorContext	findContext(String id)
String	getBareMessage() Returns the message in the bare form (without the error code part).
List<ErrorContext>	getContexts() Returns contexts in which exception occurs.
String	getErrorCode() Returns the error code.
String	getMessage()
String[]	getStackTraceInfo()
static ErrorException	wrap(Exception e) Wraps the given exception into a proper ErrorException.
static ErrorException	wrap(Exception e, String[] stackTraceInfo) Wraps the given exception into a proper ErrorException.
static ErrorException	wrap(Exception e, String contextId, String context) Wraps the given exception into a proper ErrorException.
static ErrorException	wrap(Exception e, String contextId, String context, String[] stackTraceInfo) Wraps the given exception into a proper ErrorException.

Methods inherited from class com.whitestein.lsps.common.LspsException

getModelInstanceStates, setModelInstanceStates

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

MODEL_INSTANCE_CONTEXT

public static final String MODEL_INSTANCE_CONTEXT

Key for model instance context

See Also:

Constant Field Values

MODEL_CONTEXT

public static final String MODEL_CONTEXT

Key for model context

See Also:

Constant Field Values

Constructor Detail

ErrorException

public ErrorException(String errorCode)

Creates new instance.

Parameters:

errorCode - the error code

ErrorException

public ErrorException(String errorCode,
                      String[] stackTraceInfo)

Creates new instance.

Parameters:

errorCode - the error code

stackTraceInfo - the stack trace

ErrorException

public ErrorException(String errorCode,
                      String message)

Creates new instance.

Parameters:

errorCode - the error code

message - the message

ErrorException

public ErrorException(String errorCode,
                      String message,
                      String[] stackTraceInfo)

Creates new instance.

Parameters:

errorCode - the error code

message - the message

stackTraceInfo - the stack trace

ErrorException

public ErrorException(String errorCode,
                      String message,
                      String[] stackTraceInfo,
                      String contextId,
                      String context)

Creates new instance.

Parameters:

errorCode - the error code

message - the message

stackTraceInfo - the stack trace

contextId -

context -

ErrorException

public ErrorException(String errorCode,
                      Throwable cause)

Creates new instance.

Parameters:

errorCode - the error code

cause - the cause

ErrorException

public ErrorException(String errorCode,
                      Throwable cause,
                      String[] stackTraceInfo)

Creates new instance.

Parameters:

errorCode - the error code

cause - the cause

stackTraceInfo - the stack trace

ErrorException

public ErrorException(String errorCode,
                      Throwable cause,
                      String contextId,
                      String context)

Creates new instance.

Parameters:

errorCode - the error code

cause - the cause

contextId - contextIds

context -

ErrorException

public ErrorException(String errorCode,
                      Throwable cause,
                      String contextId,
                      String context,
                      String[] stackTraceInfo)

Creates new instance.

Parameters:

errorCode - the error code

cause - the cause

contextId - contextIds

context -

stackTraceInfo - a stack trace

ErrorException

public ErrorException(String errorCode,
                      String message,
                      Throwable cause)

Creates new instance.

Parameters:

errorCode - the error code

message - the message

cause - the cause

ErrorException

public ErrorException(String errorCode,
                      String message,
                      Throwable cause,
                      String[] stackTraceInfo)

Creates new instance.

Parameters:

errorCode - the error code

message - the message

cause - the cause

stackTraceInfo - the stack trace

ErrorException

public ErrorException(ErrorRuntimeException e)

Creates new instance.

Parameters:

e -

ErrorException

public ErrorException(ErrorRuntimeException e,
                      String[] stackTraceInfo)

Creates new instance.

Parameters:

e -

stackTraceInfo -

Method Detail

getStackTraceInfo

public String[] getStackTraceInfo()

getErrorCode

public String getErrorCode()

Description copied from interface: IErrorException

Returns the error code.

Specified by:

getErrorCode in interface IErrorException

Returns:

the error code

getBareMessage

public String getBareMessage()

Description copied from interface: IErrorException

Returns the message in the bare form (without the error code part).

Specified by:

getBareMessage in interface IErrorException

Returns:

the message in the bare form (without the error code part)

getContexts

public List<ErrorContext> getContexts()

Description copied from interface: IErrorException

Returns contexts in which exception occurs.

Specified by:

getContexts in interface IErrorException

Returns:

contexts in which exception occurs

findContext

public ErrorContext findContext(String id)

Specified by:

findContext in interface IErrorException

Returns:

the error context with a given id or null if not found

wrap

public static ErrorException wrap(Exception e,
                                  String contextId,
                                  String context)

Wraps the given exception into a proper ErrorException.

Parameters:

e -

contextId -

context -

Returns:

the wrapped exception

wrap

public static ErrorException wrap(Exception e,
                                  String contextId,
                                  String context,
                                  String[] stackTraceInfo)

Wraps the given exception into a proper ErrorException.

Parameters:

e -

contextId -

context -

stackTraceInfo -

Returns:

the wrapped exception

addContextIfIdNotExists

public void addContextIfIdNotExists(String contextId,
                                    String context)

Adds a context of there is no context with a given contextId already.

Parameters:

contextId -

context -

wrap

public static ErrorException wrap(Exception e)

Wraps the given exception into a proper ErrorException.

Parameters:

e -

Returns:

the wrapped exception

wrap

public static ErrorException wrap(Exception e,
                                  String[] stackTraceInfo)

Wraps the given exception into a proper ErrorException.

Parameters:

e -

stackTraceInfo -

Returns:

the wrapped exception

addContext

public void addContext(String contextId,
                       String context)

Adds a context.

Parameters:

contextId - the context id

context - the exception context

addContexts

public void addContexts(List<ErrorContext> contexts)

Adds all contexts.

Parameters:

contexts -

addModelInstanceContext

public void addModelInstanceContext(long modelInstanceId)

Adds context on model instance.

Parameters:

modelInstanceId -

addModelContext

public void addModelContext(long modelId)

Adds context of model.

Parameters:

modelId -

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable