| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>TextMessage</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TextMessage"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/jms/TemporaryTopic.html" title="interface in jakarta.jms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/jms/Topic.html" title="interface in jakarta.jms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/jms/TextMessage.html" target="_top">Frames</a></li> |
| <li><a href="TextMessage.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.jms</div> |
| <h2 title="Interface TextMessage" class="title">Interface TextMessage</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../jakarta/jms/Message.html" title="interface in jakarta.jms">Message</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">TextMessage</span> |
| extends <a href="../../jakarta/jms/Message.html" title="interface in jakarta.jms">Message</a></pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>JMS 1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../jakarta/jms/Session.html#createTextMessage--"><code>Session.createTextMessage()</code></a>, |
| <a href="../../jakarta/jms/Session.html#createTextMessage-java.lang.String-"><code>Session.createTextMessage(String)</code></a>, |
| <a href="../../jakarta/jms/BytesMessage.html" title="interface in jakarta.jms"><code>BytesMessage</code></a>, |
| <a href="../../jakarta/jms/MapMessage.html" title="interface in jakarta.jms"><code>MapMessage</code></a>, |
| <a href="../../jakarta/jms/Message.html" title="interface in jakarta.jms"><code>Message</code></a>, |
| <a href="../../jakarta/jms/ObjectMessage.html" title="interface in jakarta.jms"><code>ObjectMessage</code></a>, |
| <a href="../../jakarta/jms/StreamMessage.html" title="interface in jakarta.jms"><code>StreamMessage</code></a>, |
| <code>String</code></dd> |
| <dt><span class="simpleTagLabel">Examples (en):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/examples/websocket-jms.html">websocket-jms</a>, <a href="../../../../../tomee-9.0/examples/tomee-jms-portability.html">tomee-jms-portability</a>, <a href="../../../../../tomee-9.0/examples/simple-mdb.html">simple-mdb</a>, <a href="../../../../../tomee-9.0/examples/simple-mdb-with-descriptor.html">simple-mdb-with-descriptor</a>, <a href="../../../../../tomee-9.0/examples/simple-mdb-and-cdi.html">simple-mdb-and-cdi</a>, <a href="../../../../../tomee-9.0/examples/simple-jms.html">simple-jms</a>, <a href="../../../../../tomee-9.0/examples/injection-of-connectionfactory.html">injection-of-connectionfactory</a></dd> |
| <dt><span class="simpleTagLabel">Examples (es):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/es/examples/simple-jms.html">simple-jms</a></dd> |
| <dt><span class="simpleTagLabel">Examples (pt):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/pt/examples/tomee-jms-portability.html">tomee-jms-portability</a>, <a href="../../../../../tomee-9.0/pt/examples/simple-mdb.html">simple-mdb</a>, <a href="../../../../../tomee-9.0/pt/examples/simple-jms.html">simple-jms</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.jakarta.jms.Message"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface jakarta.jms.<a href="../../jakarta/jms/Message.html" title="interface in jakarta.jms">Message</a></h3> |
| <code><a href="../../jakarta/jms/Message.html#DEFAULT_DELIVERY_DELAY">DEFAULT_DELIVERY_DELAY</a>, <a href="../../jakarta/jms/Message.html#DEFAULT_DELIVERY_MODE">DEFAULT_DELIVERY_MODE</a>, <a href="../../jakarta/jms/Message.html#DEFAULT_PRIORITY">DEFAULT_PRIORITY</a>, <a href="../../jakarta/jms/Message.html#DEFAULT_TIME_TO_LIVE">DEFAULT_TIME_TO_LIVE</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/TextMessage.html#getText--">getText</a></span>()</code> |
| <div class="block">Gets the string containing this message's data.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/TextMessage.html#setText-java.lang.String-">setText</a></span>(java.lang.String string)</code> |
| <div class="block">Sets the string containing this message's data.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.jakarta.jms.Message"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface jakarta.jms.<a href="../../jakarta/jms/Message.html" title="interface in jakarta.jms">Message</a></h3> |
| <code><a href="../../jakarta/jms/Message.html#acknowledge--">acknowledge</a>, <a href="../../jakarta/jms/Message.html#clearBody--">clearBody</a>, <a href="../../jakarta/jms/Message.html#clearProperties--">clearProperties</a>, <a href="../../jakarta/jms/Message.html#getBody-java.lang.Class-">getBody</a>, <a href="../../jakarta/jms/Message.html#getBooleanProperty-java.lang.String-">getBooleanProperty</a>, <a href="../../jakarta/jms/Message.html#getByteProperty-java.lang.String-">getByteProperty</a>, <a href="../../jakarta/jms/Message.html#getDoubleProperty-java.lang.String-">getDoubleProperty</a>, <a href="../../jakarta/jms/Message.html#getFloatProperty-java.lang.String-">getFloatProperty</a>, <a href="../../jakarta/jms/Message.html#getIntProperty-java.lang.String-">getIntProperty</a>, <a href="../../jakarta/jms/Message.html#getJMSCorrelationID--">getJMSCorrelationID</a>, <a href="../../jakarta/jms/Message.html#getJMSCorrelationIDAsBytes--">getJMSCorrelationIDAsBytes</a>, <a href="../../jakarta/jms/Message.html#getJMSDeliveryMode--">getJMSDeliveryMode</a>, <a href="../../jakarta/jms/Message.html#getJMSDeliveryTime--">getJMSDeliveryTime</a>, <a href="../../jakarta/jms/Message.html#getJMSDestination--">getJMSDestination</a>, <a href="../../jakarta/jms/Message.html#getJMSExpiration--">getJMSExpiration</a>, <a href="../../jakarta/jms/Message.html#getJMSMessageID--">getJMSMessageID</a>, <a href="../../jakarta/jms/Message.html#getJMSPriority--">getJMSPriority</a>, <a href="../../jakarta/jms/Message.html#getJMSRedelivered--">getJMSRedelivered</a>, <a href="../../jakarta/jms/Message.html#getJMSReplyTo--">getJMSReplyTo</a>, <a href="../../jakarta/jms/Message.html#getJMSTimestamp--">getJMSTimestamp</a>, <a href="../../jakarta/jms/Message.html#getJMSType--">getJMSType</a>, <a href="../../jakarta/jms/Message.html#getLongProperty-java.lang.String-">getLongProperty</a>, <a href="../../jakarta/jms/Message.html#getObjectProperty-java.lang.String-">getObjectProperty</a>, <a href="../../jakarta/jms/Message.html#getPropertyNames--">getPropertyNames</a>, <a href="../../jakarta/jms/Message.html#getShortProperty-java.lang.String-">getShortProperty</a>, <a href="../../jakarta/jms/Message.html#getStringProperty-java.lang.String-">getStringProperty</a>, <a href="../../jakarta/jms/Message.html#isBodyAssignableTo-java.lang.Class-">isBodyAssignableTo</a>, <a href="../../jakarta/jms/Message.html#propertyExists-java.lang.String-">propertyExists</a>, <a href="../../jakarta/jms/Message.html#setBooleanProperty-java.lang.String-boolean-">setBooleanProperty</a>, <a href="../../jakarta/jms/Message.html#setByteProperty-java.lang.String-byte-">setByteProperty</a>, <a href="../../jakarta/jms/Message.html#setDoubleProperty-java.lang.String-double-">setDoubleProperty</a>, <a href="../../jakarta/jms/Message.html#setFloatProperty-java.lang.String-float-">setFloatProperty</a>, <a href="../../jakarta/jms/Message.html#setIntProperty-java.lang.String-int-">setIntProperty</a>, <a href="../../jakarta/jms/Message.html#setJMSCorrelationID-java.lang.String-">setJMSCorrelationID</a>, <a href="../../jakarta/jms/Message.html#setJMSCorrelationIDAsBytes-byte:A-">setJMSCorrelationIDAsBytes</a>, <a href="../../jakarta/jms/Message.html#setJMSDeliveryMode-int-">setJMSDeliveryMode</a>, <a href="../../jakarta/jms/Message.html#setJMSDeliveryTime-long-">setJMSDeliveryTime</a>, <a href="../../jakarta/jms/Message.html#setJMSDestination-jakarta.jms.Destination-">setJMSDestination</a>, <a href="../../jakarta/jms/Message.html#setJMSExpiration-long-">setJMSExpiration</a>, <a href="../../jakarta/jms/Message.html#setJMSMessageID-java.lang.String-">setJMSMessageID</a>, <a href="../../jakarta/jms/Message.html#setJMSPriority-int-">setJMSPriority</a>, <a href="../../jakarta/jms/Message.html#setJMSRedelivered-boolean-">setJMSRedelivered</a>, <a href="../../jakarta/jms/Message.html#setJMSReplyTo-jakarta.jms.Destination-">setJMSReplyTo</a>, <a href="../../jakarta/jms/Message.html#setJMSTimestamp-long-">setJMSTimestamp</a>, <a href="../../jakarta/jms/Message.html#setJMSType-java.lang.String-">setJMSType</a>, <a href="../../jakarta/jms/Message.html#setLongProperty-java.lang.String-long-">setLongProperty</a>, <a href="../../jakarta/jms/Message.html#setObjectProperty-java.lang.String-java.lang.Object-">setObjectProperty</a>, <a href="../../jakarta/jms/Message.html#setShortProperty-java.lang.String-short-">setShortProperty</a>, <a href="../../jakarta/jms/Message.html#setStringProperty-java.lang.String-java.lang.String-">setStringProperty</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setText-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setText</h4> |
| <pre>void setText(java.lang.String string) |
| throws <a href="../../jakarta/jms/JMSException.html" title="class in jakarta.jms">JMSException</a></pre> |
| <div class="block">Sets the string containing this message's data.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>string</code> - the <code>String</code> containing the message's data</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/jms/JMSException.html" title="class in jakarta.jms">JMSException</a></code> - if the Jakarta Messaging provider fails to set the text due to some internal error.</dd> |
| <dd><code><a href="../../jakarta/jms/MessageNotWriteableException.html" title="class in jakarta.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getText--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getText</h4> |
| <pre>java.lang.String getText() |
| throws <a href="../../jakarta/jms/JMSException.html" title="class in jakarta.jms">JMSException</a></pre> |
| <div class="block">Gets the string containing this message's data. The default value is null.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>String</code> containing the message's data</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/jms/JMSException.html" title="class in jakarta.jms">JMSException</a></code> - if the Jakarta Messaging provider fails to get the text due to some internal error.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/jms/TemporaryTopic.html" title="interface in jakarta.jms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/jms/Topic.html" title="interface in jakarta.jms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/jms/TextMessage.html" target="_top">Frames</a></li> |
| <li><a href="TextMessage.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |