com.ibm.itim.exception
Class ITIMException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.ibm.itim.exception.ITIMException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ApplicationException, ModelException, ScriptEvaluatorException

public abstract class ITIMException
extends java.lang.Exception

This class is capable of accepting values for replaceable tokens, which may be used in MessageFormater to format "flexible" error desciptions

See Also:
Serialized Form

Method Summary
 java.lang.String getMessage()
          Method will return error message for the default locale.
 java.lang.String getMessage(java.util.Locale locale)
           
 java.lang.String getMessageId()
          This method returns the message identifier for this exeception.
 java.lang.Throwable getThrowable()
          Accessor method for the nested throwable contained in this exception.
 java.lang.Object[] getTokens()
          This method will get the Object[] of tokens which are used in the localized message.
static java.lang.String normalize(java.lang.String s, boolean canonical)
          Normalizes the given string.
 void printStackTrace()
          Prints this Throwable and its backtrace to the standard error stream.
 void printStackTrace(java.io.PrintStream s)
          Prints this Throwable and its backtrace to the specified print stream.
 void printStackTrace(java.io.PrintWriter s)
          Prints this Throwable and its backtrace to the specified print writer.
 java.lang.String toXML()
          Returns a XML representation of this exception message and parameters that can be localized in the ITIM UI.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getMessageId

public java.lang.String getMessageId()
This method returns the message identifier for this exeception.
Returns:
the message identifier for this exception

getTokens

public java.lang.Object[] getTokens()
This method will get the Object[] of tokens which are used in the localized message.
Returns:
Object[] with message token values.

getMessage

public java.lang.String getMessage()
Method will return error message for the default locale.
Overrides:
getMessage in class java.lang.Throwable
Returns:
formatted, internationalized error message using the message id and token values defined in an object of this class.

getMessage

public java.lang.String getMessage(java.util.Locale locale)

getThrowable

public java.lang.Throwable getThrowable()
Accessor method for the nested throwable contained in this exception.
Returns:
the nested throwable object contained within this object.

printStackTrace

public void printStackTrace()
Prints this Throwable and its backtrace to the standard error stream. This method prints a stack trace for this Throwable object on the error output stream that is the value of the field System.err. The first line of output contains the result of the toString() method for this object.
Overrides:
printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream s)
Prints this Throwable and its backtrace to the specified print stream.
Overrides:
printStackTrace in class java.lang.Throwable
Parameters:
s - PrintStream to use for output

printStackTrace

public void printStackTrace(java.io.PrintWriter s)
Prints this Throwable and its backtrace to the specified print writer.
Overrides:
printStackTrace in class java.lang.Throwable
Parameters:
s - PrintWriter to use for output

toXML

public java.lang.String toXML()
Returns a XML representation of this exception message and parameters that can be localized in the ITIM UI.
Returns:
The formatted XML message.

normalize

public static java.lang.String normalize(java.lang.String s,
                                         boolean canonical)
Normalizes the given string.