com.sun.messaging.jms

Class MessageFormatException

java.lang.Object

java.lang.Throwable

java.lang.Exception

javax.jms.JMSException

javax.jms.MessageFormatException

com.sun.messaging.jms.MessageFormatException

All Implemented Interfaces:

com.sun.messaging.jmq.jmsclient.logging.Loggable, Serializable

public class MessageFormatException
extends MessageFormatException
implements com.sun.messaging.jmq.jmsclient.logging.Loggable

This exception must be thrown when a JMS client attempts to use a data type not supported by a message or attempts to read data in a message as the wrong type. It must also be thrown when equivalent type errors are made with message property values. For example, this exception must be thrown if StreamMessage.writeObject is given an unsupported class or if StreamMessage.readShort is used to read a boolean value. Note that the special case of a failure caused by an attempt to read improperly formatted String data as numeric values must throw the java.lang.NumberFormatException.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MessageFormatException(String reason) Constructs a MessageFormatException with the specified reason and with the error code defaulting to null.
MessageFormatException(String reason, String errorCode) Constructs a MessageFormatException with the specified reason and error code.
MessageFormatException(String reason, String errorCode, Throwable cause) Constructs a MessageFormatException with the specified reason, error code, and a specified cause.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getLogState() get logging state of this object.
void	printStackTrace() If running under versions of the Java platform prior to J2SE1.4, this method will also print the backtrace of the exception linked to this MessageFormatException and obtained via javax.jms.JMSException.getLinkedException()
void	printStackTrace(PrintStream s) If running under versions of the Java platform prior to J2SE1.4, this method will also print the backtrace of the exception linked to this MessageFormatException and obtained via javax.jms.JMSException.getLinkedException()
void	printStackTrace(PrintWriter s) If running under versions of the Java platform prior to J2SE1.4, this method will also print the backtrace of the exception linked to this MessageFormatException and obtained via JMSException.getLinkedException()
void	setLinkedException(Exception ex) If running under J2SE1.4 or above, this method will also set the cause of the MessageFormatException.
void	setLogState(boolean state) set state to true if this object is logged.

Methods inherited from class javax.jms.JMSException

getErrorCode, getLinkedException

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageFormatException

public MessageFormatException(String reason,
                      String errorCode)

Constructs a MessageFormatException with the specified reason and error code.

Parameters:

reason - a description of the exception

errorCode - a string specifying the vendor-specific error code

MessageFormatException

public MessageFormatException(String reason)

Constructs a MessageFormatException with the specified reason and with the error code defaulting to null.

Parameters:

reason - a description of the exception

MessageFormatException

public MessageFormatException(String reason,
                      String errorCode,
                      Throwable cause)

Constructs a MessageFormatException with the specified reason, error code, and a specified cause.

Parameters:

reason - a description of the exception

errorCode - a string specifying the vendor-specific error code

cause - the cause. A null value is permitted, and indicates that the cause is non-existent or unknown.

Method Detail

setLinkedException

public void setLinkedException(Exception ex)

If running under J2SE1.4 or above, this method will also set the cause of the MessageFormatException. When a backtrace of the MessageFormatException is printed using printStackTrace using printStackTrace a backtrace of the cause will also get printed.

Overrides:

setLinkedException in class JMSException

Parameters:

ex - the linked Exception

printStackTrace

public void printStackTrace()

If running under versions of the Java platform prior to J2SE1.4, this method will also print the backtrace of the exception linked to this MessageFormatException and obtained via javax.jms.JMSException.getLinkedException()

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintStream s)

If running under versions of the Java platform prior to J2SE1.4, this method will also print the backtrace of the exception linked to this MessageFormatException and obtained via javax.jms.JMSException.getLinkedException()

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintWriter s)

If running under versions of the Java platform prior to J2SE1.4, this method will also print the backtrace of the exception linked to this MessageFormatException and obtained via JMSException.getLinkedException()

Overrides:

printStackTrace in class Throwable

setLogState

public void setLogState(boolean state)

set state to true if this object is logged.

Specified by:

setLogState in interface com.sun.messaging.jmq.jmsclient.logging.Loggable

Parameters:

state - boolean

getLogState

public boolean getLogState()

get logging state of this object.

Specified by:

getLogState in interface com.sun.messaging.jmq.jmsclient.logging.Loggable

Returns:

boolean true if this object is logged.