javax.jms.TextMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ow2-jms-2.0-spec Show documentation
The Java Message Service (JMS) API, version 2.0
The newest version!
/**
 * Copyright 2013 ScalAgent Distributed Technologies
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  ---------------------------------------------------------------------
 *  $Id: TextMessage.java 6347 2013-03-13 08:52:02Z tachker $
 *  ---------------------------------------------------------------------
 */

package javax.jms;

/**
 * A {@code TextMessage} object is used to send a message containing a
 * {@code java.lang.String}. It inherits from the {@code Message} interface and
 * adds a text message body.
 * 
 * @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
 * 
 * @version JMS 2.0
 * @since JMS 1.0
 * 
 */

public interface TextMessage extends Message {

  /**
   * Sets the string containing this message's data.
   * 
   * @param string
   *          the {@code String} 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} 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;
}