net.firstpartners.nounit.utility
Class NoUnitException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--net.firstpartners.nounit.utility.NoUnitException
All Implemented Interfaces:
java.io.Serializable

public class NoUnitException
extends java.lang.Exception

System Wide Exception (containing original Exception & user friendly message) thrown whenever invalid values are found.

See Also:
Serialized Form

Constructor Summary
NoUnitException(java.lang.Exception inException, java.lang.String userFriendlyMessage)
          Constructor , repackages other Exceptions to add (User Friendly) information
NoUnitException(java.lang.String inUserErrorMessage)
          Constructor , calls exception with value pair information , plus reason
NoUnitException(java.lang.String inValidValueName, java.lang.String inValidValue)
          Constructor , calls exception with value pair information
NoUnitException(java.lang.String inValidValueName, java.lang.String inValidValue, java.lang.String reason)
          Constructor , calls exception with value pair information , plus reason
 
Method Summary
 java.lang.Exception getOriginalException()
          return the internal / original Exception , if any
 java.lang.String getUserErrorMessage()
          Returns the userFriendly Error Message
 java.lang.String toString()
          Over-rides the toString method to provide more information.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NoUnitException

public NoUnitException(java.lang.Exception inException,
                       java.lang.String userFriendlyMessage)
Constructor , repackages other Exceptions to add (User Friendly) information
Parameters:
inException - to hold
userFriendlyMessage - to display to user

NoUnitException

public NoUnitException(java.lang.String inValidValueName,
                       java.lang.String inValidValue)
Constructor , calls exception with value pair information
Parameters:
inValidValueName - - the name the value was stored under
inValidValue - - the value that was rejected

NoUnitException

public NoUnitException(java.lang.String inValidValueName,
                       java.lang.String inValidValue,
                       java.lang.String reason)
Constructor , calls exception with value pair information , plus reason
Parameters:
inValidValueName - - the name the value was stored under
inValidValue - - the value that was rejected
reason - - the reason why the value was rejected

NoUnitException

public NoUnitException(java.lang.String inUserErrorMessage)
Constructor , calls exception with value pair information , plus reason
Parameters:
inUserErrorMessage - that will be displayed to the user
Method Detail

getUserErrorMessage

public java.lang.String getUserErrorMessage()
Returns the userFriendly Error Message
Returns:
userErrorMessage

toString

public java.lang.String toString()
Over-rides the toString method to provide more information.
Overrides:
toString in class java.lang.Throwable
Returns:
infoString containing concatanated original error (if any) , plus any user friendly messages.

getOriginalException

public java.lang.Exception getOriginalException()
return the internal / original Exception , if any
Returns:
internalException that is stored when this was created