at.spardat.xma.boot.exc
Class BootRuntimeException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byat.spardat.xma.boot.exc.BootRuntimeException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
BRLoginException, ServerVersionException

public class BootRuntimeException
extends java.lang.Exception

See Also:
Serialized Form

Field Summary
protected  boolean showToEndUser_
          As for runtime exceptions: Indicates if this exception may be shown to the end user or not.
 
Constructor Summary
protected BootRuntimeException()
          For internal use only.
  BootRuntimeException(java.lang.String message)
          Constructs and sets the message to the provided value.
  BootRuntimeException(java.lang.String message, java.util.Locale l, java.lang.Object[] params)
          Constructs and sets the message from a format string as defined in java.text.MessageFormat.
  BootRuntimeException(java.lang.String messageFmt, java.lang.Object param1)
          Constructs and sets the message of this from a one parameter java.text.MessageFormat compatible string.
  BootRuntimeException(java.lang.String messageFmt, java.lang.Object param1, java.lang.Object param2)
          Constructs and sets the message of this from a two parameter java.text.MessageFormat compatible string.
  BootRuntimeException(java.lang.Throwable detail, java.lang.String message)
           
  BootRuntimeException(java.lang.Throwable detail, java.lang.String message, java.util.Locale l, java.lang.Object[] params)
          Constructs and sets the message from a format string as defined in java.text.MessageFormat.
 
Method Summary
 int getCode()
          Returns the code set.
 java.lang.Throwable getDetail()
          Returns the detail throwable.
 java.lang.String getMessage()
           
 boolean getShowToEndUser()
           
 BootRuntimeException setCode(int code)
          Sets the code.
 BootRuntimeException setMessage(java.lang.String message)
          Constructs and sets the message to the provided value.
 BootRuntimeException setMessage(java.lang.String message, java.util.Locale l, java.lang.Object[] params)
          Sets the message from a format string as defined in java.text.MessageFormat.
 BootRuntimeException setMessage(java.lang.String messageFmt, java.lang.Object param1)
          Sets the message of this from a one parameter java.text.MessageFormat compatible string.
 BootRuntimeException setMessage(java.lang.String messageFmt, java.lang.Object param1, java.lang.Object param2)
          Sets the message of this from a one parameter java.text.MessageFormat compatible string.
 BootRuntimeException setShowToEndUser(boolean bIn)
           
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, 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

showToEndUser_

protected boolean showToEndUser_
As for runtime exceptions: Indicates if this exception may be shown to the end user or not. This is just a hint for the presentation layer to decide if it should wrap this in another exception.

Constructor Detail

BootRuntimeException

protected BootRuntimeException()
For internal use only.


BootRuntimeException

public BootRuntimeException(java.lang.Throwable detail,
                            java.lang.String message,
                            java.util.Locale l,
                            java.lang.Object[] params)
Constructs and sets the message from a format string as defined in java.text.MessageFormat. The required parameters must be contained in the params array.

Parameters:
detail - detail exception.
message - string that either is a java.text.MessageFormat or not, depending on params.
l - a java.util.Locale to format locale dependent data types or null if the params do not contain local specifics.
params - the parameters of the message. If not null, message is expected to be a string compliant to MessageFormat.

BootRuntimeException

public BootRuntimeException(java.lang.Throwable detail,
                            java.lang.String message)

BootRuntimeException

public BootRuntimeException(java.lang.String messageFmt,
                            java.lang.Object param1,
                            java.lang.Object param2)
Constructs and sets the message of this from a two parameter java.text.MessageFormat compatible string.

Parameters:
messageFmt - format string as defined in java.text.MessageFormat.
param1 - first message parameter
param2 - second message parameter

BootRuntimeException

public BootRuntimeException(java.lang.String messageFmt,
                            java.lang.Object param1)
Constructs and sets the message of this from a one parameter java.text.MessageFormat compatible string.

Parameters:
messageFmt - format string as defined in java.text.MessageFormat.
param1 - message parameter

BootRuntimeException

public BootRuntimeException(java.lang.String message)
Constructs and sets the message to the provided value.

Parameters:
message - message text.

BootRuntimeException

public BootRuntimeException(java.lang.String message,
                            java.util.Locale l,
                            java.lang.Object[] params)
Constructs and sets the message from a format string as defined in java.text.MessageFormat. The required parameters must be contained in the params array.

Parameters:
message - format string as defined in java.text.MessageFormat or plain text that is not a MessageFormat, depending on params
l - a java.util.Locale to format locale dependent data types or null if the params do not contain local specifics.
params - the parameters of the message. If params is null, message is not subject to MessageFormat-processing. If params is not null, message must be compliant to java.text.MessageFormat.
Method Detail

setMessage

public BootRuntimeException setMessage(java.lang.String message,
                                       java.util.Locale l,
                                       java.lang.Object[] params)
Sets the message from a format string as defined in java.text.MessageFormat. The required parameters must be contained in the params array.

Parameters:
message - format string as defined in java.text.MessageFormat or plain text that is not a MessageFormat, depending on params
l - a java.util.Locale to format locale dependent data types or null if the params do not contain local specifics.
params - the parameters of the message. If params is null, message is not subject to MessageFormat-processing. If params is not null, message must be compliant to java.text.MessageFormat.
Returns:
this

setMessage

public BootRuntimeException setMessage(java.lang.String messageFmt,
                                       java.lang.Object param1,
                                       java.lang.Object param2)
Sets the message of this from a one parameter java.text.MessageFormat compatible string.

Parameters:
messageFmt - format string as defined in java.text.MessageFormat.
param1 - message parameter
param2 - message parameter
Returns:
this

setMessage

public BootRuntimeException setMessage(java.lang.String messageFmt,
                                       java.lang.Object param1)
Sets the message of this from a one parameter java.text.MessageFormat compatible string.

Parameters:
messageFmt - format string as defined in java.text.MessageFormat.
param1 - message parameter
Returns:
this

setMessage

public BootRuntimeException setMessage(java.lang.String message)
Constructs and sets the message to the provided value.

Parameters:
message - text to set
Returns:
this

setCode

public BootRuntimeException setCode(int code)
Sets the code. The code must be greater than zero.

See Also:
getCode()

getCode

public int getCode()
Returns the code set. The code should be used to discrimitate amongst different kinds of notifications.


getMessage

public java.lang.String getMessage()
Returns:
String message

getDetail

public java.lang.Throwable getDetail()
Returns the detail throwable. The returned value is null if no detail has been set or this has been migrated and the detail is not an BaseException.


setShowToEndUser

public BootRuntimeException setShowToEndUser(boolean bIn)

getShowToEndUser

public boolean getShowToEndUser()