com.ibm.itim.exception
Class ITIMRuntimeException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--com.ibm.itim.exception.ITIMRuntimeException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PasswordRulesRuntimeException

public abstract class ITIMRuntimeException

extends java.lang.RuntimeException

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	getLocalizedMessage() Method will return error message for the default locale.
java.lang.String	getMessage() Method will return error message for Locale.US.
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() Deprecated.
java.lang.Object[]	getTokens() This method will get the Object[] of tokens which are used in the localized message.
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, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, 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.

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Method will return error message for the default locale.

Overrides:

getLocalizedMessage 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()

Method will return error message for Locale.US.

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.

See Also:

Locale.US

getMessage

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

getThrowable

public java.lang.Throwable getThrowable()

Deprecated.

Accessor method for the nested throwable contained in this exception.

Returns:

the nested throwable object contained within this object.

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.