com.ricebridge.data
Class DataException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              org.jostraca.util.StandardException
                  com.ricebridge.data.in.DataBaseException
                      com.ricebridge.data.DataException

All Implemented Interfaces:

Serializable

public class DataException

extends DataBaseException

RuntimeException for exceptions occurring in the com.ricebridge.data package.

For a list of error codes, see the MsgCode class. For the error message texts, see the messages.properties file.

See Also:

XmlManagerException, Serialized Form

Nested Class Summary

Nested classes inherited from class com.ricebridge.data.in.DataBaseException

DataBaseException.Code

Nested classes inherited from class org.jostraca.util.StandardException

StandardException.Cat

Field Summary

Fields inherited from class com.ricebridge.data.in.DataBaseException

CODE_badequal, CODE_general, CODE_internal_exception, CODE_invoke_method, CODE_newinstance, CODE_sc_def_obj, CODE_sc_def_str, CODE_sc_null, CODE_sc_object, CODE_sc_string, CODE_system

Fields inherited from class org.jostraca.util.StandardException

CODE_user, DEFAULT_CODE, iCode, iContained, iContext, iOrigin, iOriginalMessage, KEY_standard

Constructor Summary

DataException()
An empty DataException.

DataException(DataBaseException.Code pCode)
Specify the error code.

DataException(DataBaseException.Code pCode, Object pContext)
Specify the error code, and the error context.

DataException(DataBaseException.Code pCode, String pText)
Specify the error code, and the error message text.

DataException(DataBaseException.Code pCode, String[] pContext)
Specify the error code, and provide a set of replacement values for the user-friendly error message associated with this code.

DataException(DataBaseException.Code pCode, String[] pContext, Throwable pContained)
Specify the error code, provide a set of replacement values for the user-friendly error message associated with this code, and the original Exception that caused the error.

DataException(DataBaseException.Code pCode, String pText, Throwable pContained)
Specify the error code, the error message test, and the original Exception that caused the error.

DataException(DataBaseException.Code pCode, Throwable pContained)
Specify the error code, and the original Exception that caused the error.

DataException(Throwable pContained)
Specify the error code.

Method Summary

String	getUserMessage() Return a user-friendly error message describing the problem.
UserMessageFormatter	getUserMessageFormatter() Get the UserMessageFormatter object that formats user-friendly error messages.
String	toString() Return a user-friendly error message describing the problem.

Methods inherited from class com.ricebridge.data.in.DataBaseException

CODE_badequal, CODE_badequal, CODE_badequal, CODE_badequal, CODE_badequal, CODE_badequal, CODE_general, CODE_general, CODE_general, CODE_general, CODE_general, CODE_general, CODE_internal_exception, CODE_internal_exception, CODE_internal_exception, CODE_internal_exception, CODE_internal_exception, CODE_internal_exception, CODE_invoke_method, CODE_invoke_method, CODE_invoke_method, CODE_invoke_method, CODE_invoke_method, CODE_invoke_method, CODE_newinstance, CODE_newinstance, CODE_newinstance, CODE_newinstance, CODE_newinstance, CODE_newinstance, CODE_sc_def_obj, CODE_sc_def_obj, CODE_sc_def_obj, CODE_sc_def_obj, CODE_sc_def_obj, CODE_sc_def_obj, CODE_sc_def_str, CODE_sc_def_str, CODE_sc_def_str, CODE_sc_def_str, CODE_sc_def_str, CODE_sc_def_str, CODE_sc_null, CODE_sc_null, CODE_sc_null, CODE_sc_null, CODE_sc_null, CODE_sc_null, CODE_sc_object, CODE_sc_object, CODE_sc_object, CODE_sc_object, CODE_sc_object, CODE_sc_object, CODE_sc_string, CODE_sc_string, CODE_sc_string, CODE_sc_string, CODE_sc_string, CODE_sc_string, CODE_system, CODE_system, CODE_system, CODE_system, CODE_system, CODE_system, getPackage

Methods inherited from class org.jostraca.util.StandardException

formatContextValues, formatContextValues, formatContextValues, getCat, getCode, getContained, getContainedStandard, getContext, getContextValues, getContextValues, getKey, getOriginalMessage, hasContained, makeStackTrace

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DataException

public DataException()

An empty DataException.

DataException

public DataException(DataBaseException.Code pCode)

Specify the error code.

Parameters:

pCode - DataBaseException.Code object

DataException

public DataException(DataBaseException.Code pCode,
                     Object pContext)

Specify the error code, and the error context.

Parameters:

pCode - DataBaseException.Code object

pContext - user-defined object describing error context

DataException

public DataException(DataBaseException.Code pCode,
                     String pText)

Specify the error code, and the error message text.

Parameters:

pCode - DataBaseException.Code object

pText - error message text

DataException

public DataException(DataBaseException.Code pCode,
                     String pText,
                     Throwable pContained)

Specify the error code, the error message test, and the original Exception that caused the error.

Parameters:

pCode - DataBaseException.Code object

pText - error message text

pContained - Exception that caused the error

DataException

public DataException(DataBaseException.Code pCode,
                     String[] pContext)

Specify the error code, and provide a set of replacement values for the user-friendly error message associated with this code.

Parameters:

pCode - DataBaseException.Code object

pContext - error message values

DataException

public DataException(DataBaseException.Code pCode,
                     Throwable pContained)

Specify the error code, and the original Exception that caused the error.

Parameters:

pCode - DataBaseException.Code object

pContained - Exception that caused the error

DataException

public DataException(DataBaseException.Code pCode,
                     String[] pContext,
                     Throwable pContained)

Specify the error code, provide a set of replacement values for the user-friendly error message associated with this code, and the original Exception that caused the error.

Parameters:

pCode - DataBaseException.Code object

pContext - error message values

pContained - Exception that caused the error

DataException

public DataException(Throwable pContained)

Specify the error code.

Parameters:

pContained - Exception that caused the error

Method Detail

toString

public String toString()

Return a user-friendly error message describing the problem.

See Also:

getUserMessage()

getUserMessage

public String getUserMessage()

Return a user-friendly error message describing the problem.

Note that the standard getMessage method returns a technical description of the error more suitable for debugging.

getUserMessageFormatter

public UserMessageFormatter getUserMessageFormatter()

Get the UserMessageFormatter object that formats user-friendly error messages.