Class DetailedMessageEOFException

java.lang.Object

java.lang.Throwable

java.lang.Exception

jakarta.jms.JMSException

jakarta.jms.MessageEOFException

com.ibm.msg.client.jakarta.jms.DetailedMessageEOFException

All Implemented Interfaces:

JmsExceptionDetail, Serializable

public class DetailedMessageEOFException
extends jakarta.jms.MessageEOFException
implements JmsExceptionDetail

DetailedMessageEOFException is a subclass of MessageEOFException that provides methods to get the message id, explanation, user action and inserts of the translatable message inside the MessageEOFException. When the IBM MQ classes for JMS client throws a MessageEOFException, applications can cast it to a DetailedMessageEOFException to get this extra information.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DetailedMessageEOFException()

Method Summary

Modifier and Type	Method	Description
String	getExplanation()	Gets an explanation of the message in this exception.
Iterator<String>	getKeys()	Gets an iterator for all the message insert keys for the message in this exception.
String	getUserAction()	Gets a user response to the message in this exception.
String	getValue(String insertKey)	Gets the message insert corresponding to a particular key for the translatable message in this exception.
void	setLinkedException(Exception ex)	Adds a linked exception.
String	toString()	Returns a short description of this exception

Methods inherited from class jakarta.jms.JMSException

getErrorCode, getLinkedException

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DetailedMessageEOFException

public DetailedMessageEOFException()

Method Details

getExplanation

public 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

public 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

public String getValue(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

public Iterator<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

public void setLinkedException(Exception ex)

Adds a linked exception.

Overrides:

setLinkedException in class jakarta.jms.JMSException

Parameters:

ex - the linked Exception

See Also:

• JMSException.setLinkedException(java.lang.Exception)

toString

public String toString()

Returns a short description of this exception

Overrides:

toString in class Throwable

Returns:

a String representation of the exception