com.ge.grc.acuity
Class AcuityException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.ge.grc.acuity.AcuityException

All Implemented Interfaces:

java.io.Serializable

public class AcuityException

extends java.lang.Exception

This class provides an Exception class specific to the AcuityController

Version:

$Revision: 1.2 $ Last modified on $Date: 2006/09/08 22:38:47 $

Author:

crapo

See Also:

Serialized Form

Constructor Summary

AcuityException()

AcuityException(java.lang.String regMsg)
Construct an Exception with a single String error message

AcuityException(java.lang.String regMsg, java.lang.String _msgKey, java.lang.Object _userFriendlyMsgValues)
Construct an Exception with a regular developer-targeted String error message and a key for looking up a user-friendly error message.

AcuityException(java.lang.String regMsg, java.lang.Throwable e)
Construct an Exception from both a String error message and a Throwable object

AcuityException(java.lang.String regMsg, java.lang.Throwable e, java.lang.String _msgKey, java.lang.Object _userFriendlyMsgValues)
Construct an Exception with a regular developer-targeted String error message and a key for looking up a user-friendly error message.

AcuityException(java.lang.Throwable e)
Construct an Exception from a Throwable object

Method Summary

java.lang.String

getUserFriendlyMessage() Call this method to get the user-friendly message associated with an instance of AcuityException.

Methods inherited from class java.lang.Throwable

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

AcuityException

public AcuityException()

AcuityException

public AcuityException(java.lang.String regMsg)

Construct an Exception with a single String error message

Parameters:

regMsg -

AcuityException

public AcuityException(java.lang.Throwable e)

Construct an Exception from a Throwable object

Parameters:

e -

AcuityException

public AcuityException(java.lang.String regMsg,
                       java.lang.Throwable e)

Construct an Exception from both a String error message and a Throwable object

Parameters:

regMsg -

e -

AcuityException

public AcuityException(java.lang.String regMsg,
                       java.lang.String _msgKey,
                       java.lang.Object _userFriendlyMsgValues)

Construct an Exception with a regular developer-targeted String error message and a key for looking up a user-friendly error message. The lookup message may have replaceable placeholders of the form "#1", "#2", etc., which will be replaced with values when the user-friendly message is retrieved (by calling getUserFriendlyMessage()).

Parameters:

regMsg - - the regular developer-targeted error message

_msgKey - - the unique key identifying the user-friendly message to be looked up in a resource file

_userFriendlyMsgValues - - a single value or a List of values to be used to replace placeholders in the user-friendly message

AcuityException

public AcuityException(java.lang.String regMsg,
                       java.lang.Throwable e,
                       java.lang.String _msgKey,
                       java.lang.Object _userFriendlyMsgValues)

Construct an Exception with a regular developer-targeted String error message and a key for looking up a user-friendly error message. The lookup message may have replaceable placeholders of the form "#1", "#2", etc., which will be replaced with values when the user-friendly message is retrieved (by calling getUserFriendlyMessage()).

Parameters:

regMsg - - the regular developer-targeted error message

e - - a Throwable object

_msgKey - - the unique key identifying the user-friendly message to be looked up in a resource file

_userFriendlyMsgValues - - a single value or a List of values to be used to replace placeholders in the user-friendly message

Method Detail

getUserFriendlyMessage

public java.lang.String getUserFriendlyMessage()

Call this method to get the user-friendly message associated with an instance of AcuityException. If no user-friendly message is associated with this instance null will be returned.

Returns: