Class MessageFormatException
- All Implemented Interfaces:
com.sun.messaging.jmq.jmsclient.logging.Loggable
,Serializable
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:
-
Constructor Summary
ConstructorsConstructorDescriptionMessageFormatException
(String reason, String errorCode) Constructs aMessageFormatException
with the specified reason and error code. -
Method Summary
Modifier and TypeMethodDescriptionboolean
get logging state of this object.void
If running under versions of the Java platform prior to J2SE1.4, this method will also print the backtrace of the exception linked to thisMessageFormatException
and obtained viajakarta.jms.JMSException.getLinkedException()
void
void
If running under versions of the Java platform prior to J2SE1.4, this method will also print the backtrace of the exception linked to thisMessageFormatException
and obtained viaJMSException.getLinkedException()
void
If running under J2SE1.4 or above, this method will also set the cause of theMessageFormatException
.void
setLogState
(boolean state) set state to true if this object is logged.Methods inherited from class jakarta.jms.JMSException
getErrorCode, getLinkedException
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString
-
Constructor Details
-
MessageFormatException
Constructs aMessageFormatException
with the specified reason and error code.- Parameters:
reason
- a description of the exceptionerrorCode
- a string specifying the vendor-specific error code
-
-
Method Details
-
setLinkedException
If running under J2SE1.4 or above, this method will also set the cause of the
MessageFormatException
. When a backtrace of theMessageFormatException
is printed usingprintStackTrace
usingprintStackTrace
a backtrace of the cause will also get printed.- Overrides:
setLinkedException
in classjakarta.jms.JMSException
-
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 viajakarta.jms.JMSException.getLinkedException()
- Overrides:
printStackTrace
in classThrowable
-
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 viajakarta.jms.JMSException.getLinkedException()
- Overrides:
printStackTrace
in classThrowable
-
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 viaJMSException.getLinkedException()
- Overrides:
printStackTrace
in classThrowable
-
setLogState
public void setLogState(boolean state) set state to true if this object is logged.- Specified by:
setLogState
in interfacecom.sun.messaging.jmq.jmsclient.logging.Loggable
- Parameters:
state
- boolean
-
getLogState
public boolean getLogState()get logging state of this object.- Specified by:
getLogState
in interfacecom.sun.messaging.jmq.jmsclient.logging.Loggable
- Returns:
- boolean true if this object is logged.
-