TextMessage.java |
/* * JBoss, the OpenSource EJB server * * Distributable under LGPL license. * See terms of license at gnu.org. */ package javax.jms; /** A <CODE>TextMessage</CODE> object is used to send a message containing a * <CODE>java.lang.String</CODE>. * It inherits from the <CODE>Message</CODE> interface and adds a text message * body. * * <P>This message type can be used to transport text-based messages, including * those with XML content. * * <P>When a client receives a <CODE>TextMessage</CODE>, it is in read-only * mode. If a client attempts to write to the message at this point, a * <CODE>MessageNotWriteableException</CODE> is thrown. If * <CODE>clearBody</CODE> is * called, the message can now be both read from and written to. * * @see javax.jms.Session#createTextMessage() * @see javax.jms.Session#createTextMessage(String) * @see javax.jms.BytesMessage * @see javax.jms.MapMessage * @see javax.jms.Message * @see javax.jms.ObjectMessage * @see javax.jms.StreamMessage * @see java.lang.String */ public interface TextMessage extends Message { /** Sets the string containing this message's data. * * @param string the <CODE>String</CODE> containing the message's data * * @exception JMSException if the JMS provider fails to set the text due to * some internal error. * @exception MessageNotWriteableException if the message is in read-only * mode. */ void setText(String string) throws JMSException; /** Gets the string containing this message's data. The default * value is null. * * @return the <CODE>String</CODE> containing the message's data * * @exception JMSException if the JMS provider fails to get the text due to * some internal error. */ String getText() throws JMSException; }
TextMessage.java |