com.ibm.msg.client.jms

Class DetailedMessageFormatException

  1. java.lang.Object
  2. extended byjava.lang.Throwable
  3. extended byjava.lang.Exception
  4. extended byjavax.jms.JMSException
  5. extended byjavax.jms.MessageFormatException
  6. extended bycom.ibm.msg.client.jms.DetailedMessageFormatException
All implemented interfaces:
JmsExceptionDetail, java.io.Serializable
  1. public class DetailedMessageFormatException
  2. extends javax.jms.MessageFormatException
  3. implements JmsExceptionDetail
DetailedMessageFormatException is a subclass of MessageFormatException that provides methods to get the message id, explanation, user action and inserts of the translatable message inside the MessageFormatException. When the WebSphere MQ classes for JMS client throws a MessageFormatException, applications can cast it to a DetailedMessageFormatException to get this extra information.
See Also:
Serialized Form

Constructor Summary

Constructor and Description
DetailedMessageFormatException()

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
 getExplanation()
Gets an explanation of the message in this exception.
  1. java.util.Iterator<java.lang.String>
 getKeys()
Gets an iterator for all the message insert keys for the message in this exception.
  1. java.lang.String
 getUserAction()
Gets a user response to the message in this exception.
  1. java.lang.String
 getValue(java.lang.String insertKey)
Gets the message insert corresponding to a particular key for the translatable message in this exception.
  1. void
 setLinkedException(java.lang.Exception ex)
Adds a linked exception.
  1. java.lang.String
 toString()
Returns a short description of this exception
Methods inherited from class javax.jms.JMSException
getErrorCode, getLinkedException
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DetailedMessageFormatException

  1. public DetailedMessageFormatException( )

Method Detail

getExplanation

  1. public java.lang.String getExplanation( )
Gets an explanation of the message in this exception. This may be null.
Specified by:
getExplanation in interface JmsExceptionDetail
Returns:
the explanation
See Also:
JmsExceptionDetail.getExplanation()

getUserAction

  1. public java.lang.String getUserAction( )
Gets a user response to the message in this exception. This may be null.
Specified by:
getUserAction in interface JmsExceptionDetail
Returns:
the user action
See Also:
JmsExceptionDetail.getUserAction()

getValue

  1. public java.lang.String getValue( java.lang.String insertKey)
Gets the message insert corresponding to a particular key for the translatable message in this exception. The key is a message insert constant or a property constant that is valid for this message. The valid keys for this message can be obtained using getKeys(). This method will return null if the key is not valid for this message.
Specified by:
getValue in interface JmsExceptionDetail
Parameters:
insertKey - a message insert constant or property constant valid for this message
Returns:
the insert
See Also:
JmsExceptionDetail.getValue(java.lang.String)

getKeys

  1. public java.util.Iterator<java.lang.String> getKeys( )
Gets an iterator for all the message insert keys for the message in this exception. The keys are the property constants or message insert constants that are valid for this message. This enables applications to discover which keys are valid for this message.
Specified by:
getKeys in interface JmsExceptionDetail
Returns:
the iterator for the message insert keys
See Also:
JmsExceptionDetail.getKeys()

setLinkedException

  1. public void setLinkedException( java.lang.Exception ex)
Adds a linked exception.
Overrides:
setLinkedException in class javax.jms.JMSException
Parameters:
ex - the linked Exception
See Also:
JMSException.setLinkedException(java.lang.Exception)

toString

  1. public java.lang.String toString( )
Returns a short description of this exception
Overrides:
toString in class java.lang.Throwable
Returns:
a String representation of the exception