| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>MapMessage</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MapMessage"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":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="../../javax/jms/JMSSessionMode.html" title="annotation in javax.jms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/jms/Message.html" title="interface in javax.jms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/jms/MapMessage.html" target="_top">Frames</a></li> |
| <li><a href="MapMessage.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">javax.jms</div> |
| <h2 title="Interface MapMessage" class="title">Interface MapMessage</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../javax/jms/Message.html" title="interface in javax.jms">Message</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../org/apache/openejb/resource/activemq/jms2/WrappingMapMessage.html" title="class in org.apache.openejb.resource.activemq.jms2">WrappingMapMessage</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">MapMessage</span> |
| extends <a href="../../javax/jms/Message.html" title="interface in javax.jms">Message</a></pre> |
| <div class="block">A <code>MapMessage</code> object is used to send a set of name-value pairs. The names are <code>String</code> objects, and the |
| values are primitive data types in the Java programming language. The names must have a value that is not null, and |
| not an empty string. The entries can be accessed sequentially or randomly by name. The order of the entries is |
| undefined. <code>MapMessage</code> inherits from the <code>Message</code> interface and adds a message body that contains a |
| Map. |
| |
| <p> |
| The primitive types can be read or written explicitly using methods for each type. They may also be read or written |
| generically as objects. For instance, a call to <code>MapMessage.setInt("foo", 6)</code> is equivalent to |
| <code>MapMessage.setObject("foo", new Integer(6))</code>. Both forms are provided, because the explicit form is convenient |
| for static programming, and the object form is needed when types are not known at compile time. |
| |
| <p> |
| When a client receives a <code>MapMessage</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. |
| |
| <p> |
| <code>MapMessage</code> objects support the following conversion table. The marked cases must be supported. The unmarked |
| cases must throw a <code>JMSException</code>. The <code>String</code>-to-primitive conversions may throw a runtime exception if |
| the primitive's <code>valueOf()</code> method does not accept it as a valid <code>String</code> representation of the |
| primitive. |
| |
| <p> |
| A value written as the row type can be read as the column type. |
| |
| <pre> |
| | | boolean byte short char int long float double String byte[] |
| |---------------------------------------------------------------------- |
| |boolean | X X |
| |byte | X X X X X |
| |short | X X X X |
| |char | X X |
| |int | X X X |
| |long | X X |
| |float | X X X |
| |double | X X |
| |String | X X X X X X X X |
| |byte[] | X |
| |---------------------------------------------------------------------- |
| </pre> |
| |
| <p> |
| Attempting to read a null value as a primitive type must be treated as calling the primitive's corresponding |
| <code>valueOf(String)</code> conversion method with a null value. Since <code>char</code> does not support a <code>String</code> |
| conversion, attempting to read a null value as a <code>char</code> must throw a <code>NullPointerException</code>.</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="../../javax/jms/Session.html#createMapMessage--"><code>Session.createMapMessage()</code></a>, |
| <a href="../../javax/jms/BytesMessage.html" title="interface in javax.jms"><code>BytesMessage</code></a>, |
| <a href="../../javax/jms/Message.html" title="interface in javax.jms"><code>Message</code></a>, |
| <a href="../../javax/jms/ObjectMessage.html" title="interface in javax.jms"><code>ObjectMessage</code></a>, |
| <a href="../../javax/jms/StreamMessage.html" title="interface in javax.jms"><code>StreamMessage</code></a>, |
| <a href="../../javax/jms/TextMessage.html" title="interface in javax.jms"><code>TextMessage</code></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.javax.jms.Message"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface javax.jms.<a href="../../javax/jms/Message.html" title="interface in javax.jms">Message</a></h3> |
| <code><a href="../../javax/jms/Message.html#DEFAULT_DELIVERY_DELAY">DEFAULT_DELIVERY_DELAY</a>, <a href="../../javax/jms/Message.html#DEFAULT_DELIVERY_MODE">DEFAULT_DELIVERY_MODE</a>, <a href="../../javax/jms/Message.html#DEFAULT_PRIORITY">DEFAULT_PRIORITY</a>, <a href="../../javax/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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#getBoolean-java.lang.String-">getBoolean</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the <code>boolean</code> value with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#getByte-java.lang.String-">getByte</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the <code>byte</code> value with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#getBytes-java.lang.String-">getBytes</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the byte array value with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>char</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#getChar-java.lang.String-">getChar</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the Unicode character value with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#getDouble-java.lang.String-">getDouble</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the <code>double</code> value with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#getFloat-java.lang.String-">getFloat</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the <code>float</code> value with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#getInt-java.lang.String-">getInt</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the <code>int</code> value with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#getLong-java.lang.String-">getLong</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the <code>long</code> value with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.util.Enumeration</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#getMapNames--">getMapNames</a></span>()</code> |
| <div class="block">Returns an <code>Enumeration</code> of all the names in the <code>MapMessage</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#getObject-java.lang.String-">getObject</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the value of the object with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#getShort-java.lang.String-">getShort</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the <code>short</code> value with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#getString-java.lang.String-">getString</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the <code>String</code> value with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#itemExists-java.lang.String-">itemExists</a></span>(java.lang.String name)</code> |
| <div class="block">Indicates whether an item exists in this <code>MapMessage</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#setBoolean-java.lang.String-boolean-">setBoolean</a></span>(java.lang.String name, |
| boolean value)</code> |
| <div class="block">Sets a <code>boolean</code> value with the specified name into the Map.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#setByte-java.lang.String-byte-">setByte</a></span>(java.lang.String name, |
| byte value)</code> |
| <div class="block">Sets a <code>byte</code> value with the specified name into the Map.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#setBytes-java.lang.String-byte:A-">setBytes</a></span>(java.lang.String name, |
| byte[] value)</code> |
| <div class="block">Sets a byte array value with the specified name into the Map.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#setBytes-java.lang.String-byte:A-int-int-">setBytes</a></span>(java.lang.String name, |
| byte[] value, |
| int offset, |
| int length)</code> |
| <div class="block">Sets a portion of the byte array value with the specified name into the Map.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#setChar-java.lang.String-char-">setChar</a></span>(java.lang.String name, |
| char value)</code> |
| <div class="block">Sets a Unicode character value with the specified name into the Map.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#setDouble-java.lang.String-double-">setDouble</a></span>(java.lang.String name, |
| double value)</code> |
| <div class="block">Sets a <code>double</code> value with the specified name into the Map.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#setFloat-java.lang.String-float-">setFloat</a></span>(java.lang.String name, |
| float value)</code> |
| <div class="block">Sets a <code>float</code> value with the specified name into the Map.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#setInt-java.lang.String-int-">setInt</a></span>(java.lang.String name, |
| int value)</code> |
| <div class="block">Sets an <code>int</code> value with the specified name into the Map.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#setLong-java.lang.String-long-">setLong</a></span>(java.lang.String name, |
| long value)</code> |
| <div class="block">Sets a <code>long</code> value with the specified name into the Map.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#setObject-java.lang.String-java.lang.Object-">setObject</a></span>(java.lang.String name, |
| java.lang.Object value)</code> |
| <div class="block">Sets an object value with the specified name into the Map.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#setShort-java.lang.String-short-">setShort</a></span>(java.lang.String name, |
| short value)</code> |
| <div class="block">Sets a <code>short</code> value with the specified name into the Map.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jms/MapMessage.html#setString-java.lang.String-java.lang.String-">setString</a></span>(java.lang.String name, |
| java.lang.String value)</code> |
| <div class="block">Sets a <code>String</code> value with the specified name into the Map.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.jms.Message"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface javax.jms.<a href="../../javax/jms/Message.html" title="interface in javax.jms">Message</a></h3> |
| <code><a href="../../javax/jms/Message.html#acknowledge--">acknowledge</a>, <a href="../../javax/jms/Message.html#clearBody--">clearBody</a>, <a href="../../javax/jms/Message.html#clearProperties--">clearProperties</a>, <a href="../../javax/jms/Message.html#getBody-java.lang.Class-">getBody</a>, <a href="../../javax/jms/Message.html#getBooleanProperty-java.lang.String-">getBooleanProperty</a>, <a href="../../javax/jms/Message.html#getByteProperty-java.lang.String-">getByteProperty</a>, <a href="../../javax/jms/Message.html#getDoubleProperty-java.lang.String-">getDoubleProperty</a>, <a href="../../javax/jms/Message.html#getFloatProperty-java.lang.String-">getFloatProperty</a>, <a href="../../javax/jms/Message.html#getIntProperty-java.lang.String-">getIntProperty</a>, <a href="../../javax/jms/Message.html#getJMSCorrelationID--">getJMSCorrelationID</a>, <a href="../../javax/jms/Message.html#getJMSCorrelationIDAsBytes--">getJMSCorrelationIDAsBytes</a>, <a href="../../javax/jms/Message.html#getJMSDeliveryMode--">getJMSDeliveryMode</a>, <a href="../../javax/jms/Message.html#getJMSDeliveryTime--">getJMSDeliveryTime</a>, <a href="../../javax/jms/Message.html#getJMSDestination--">getJMSDestination</a>, <a href="../../javax/jms/Message.html#getJMSExpiration--">getJMSExpiration</a>, <a href="../../javax/jms/Message.html#getJMSMessageID--">getJMSMessageID</a>, <a href="../../javax/jms/Message.html#getJMSPriority--">getJMSPriority</a>, <a href="../../javax/jms/Message.html#getJMSRedelivered--">getJMSRedelivered</a>, <a href="../../javax/jms/Message.html#getJMSReplyTo--">getJMSReplyTo</a>, <a href="../../javax/jms/Message.html#getJMSTimestamp--">getJMSTimestamp</a>, <a href="../../javax/jms/Message.html#getJMSType--">getJMSType</a>, <a href="../../javax/jms/Message.html#getLongProperty-java.lang.String-">getLongProperty</a>, <a href="../../javax/jms/Message.html#getObjectProperty-java.lang.String-">getObjectProperty</a>, <a href="../../javax/jms/Message.html#getPropertyNames--">getPropertyNames</a>, <a href="../../javax/jms/Message.html#getShortProperty-java.lang.String-">getShortProperty</a>, <a href="../../javax/jms/Message.html#getStringProperty-java.lang.String-">getStringProperty</a>, <a href="../../javax/jms/Message.html#isBodyAssignableTo-java.lang.Class-">isBodyAssignableTo</a>, <a href="../../javax/jms/Message.html#propertyExists-java.lang.String-">propertyExists</a>, <a href="../../javax/jms/Message.html#setBooleanProperty-java.lang.String-boolean-">setBooleanProperty</a>, <a href="../../javax/jms/Message.html#setByteProperty-java.lang.String-byte-">setByteProperty</a>, <a href="../../javax/jms/Message.html#setDoubleProperty-java.lang.String-double-">setDoubleProperty</a>, <a href="../../javax/jms/Message.html#setFloatProperty-java.lang.String-float-">setFloatProperty</a>, <a href="../../javax/jms/Message.html#setIntProperty-java.lang.String-int-">setIntProperty</a>, <a href="../../javax/jms/Message.html#setJMSCorrelationID-java.lang.String-">setJMSCorrelationID</a>, <a href="../../javax/jms/Message.html#setJMSCorrelationIDAsBytes-byte:A-">setJMSCorrelationIDAsBytes</a>, <a href="../../javax/jms/Message.html#setJMSDeliveryMode-int-">setJMSDeliveryMode</a>, <a href="../../javax/jms/Message.html#setJMSDeliveryTime-long-">setJMSDeliveryTime</a>, <a href="../../javax/jms/Message.html#setJMSDestination-javax.jms.Destination-">setJMSDestination</a>, <a href="../../javax/jms/Message.html#setJMSExpiration-long-">setJMSExpiration</a>, <a href="../../javax/jms/Message.html#setJMSMessageID-java.lang.String-">setJMSMessageID</a>, <a href="../../javax/jms/Message.html#setJMSPriority-int-">setJMSPriority</a>, <a href="../../javax/jms/Message.html#setJMSRedelivered-boolean-">setJMSRedelivered</a>, <a href="../../javax/jms/Message.html#setJMSReplyTo-javax.jms.Destination-">setJMSReplyTo</a>, <a href="../../javax/jms/Message.html#setJMSTimestamp-long-">setJMSTimestamp</a>, <a href="../../javax/jms/Message.html#setJMSType-java.lang.String-">setJMSType</a>, <a href="../../javax/jms/Message.html#setLongProperty-java.lang.String-long-">setLongProperty</a>, <a href="../../javax/jms/Message.html#setObjectProperty-java.lang.String-java.lang.Object-">setObjectProperty</a>, <a href="../../javax/jms/Message.html#setShortProperty-java.lang.String-short-">setShortProperty</a>, <a href="../../javax/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="getBoolean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBoolean</h4> |
| <pre>boolean getBoolean(java.lang.String name) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Returns the <code>boolean</code> value with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>boolean</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>boolean</code> value with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to read the message due to some internal error.</dd> |
| <dd><code><a href="../../javax/jms/MessageFormatException.html" title="class in javax.jms">MessageFormatException</a></code> - if this type conversion is invalid.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getByte-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getByte</h4> |
| <pre>byte getByte(java.lang.String name) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Returns the <code>byte</code> value with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>byte</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>byte</code> value with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to read the message due to some internal error.</dd> |
| <dd><code><a href="../../javax/jms/MessageFormatException.html" title="class in javax.jms">MessageFormatException</a></code> - if this type conversion is invalid.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getShort-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShort</h4> |
| <pre>short getShort(java.lang.String name) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Returns the <code>short</code> value with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>short</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>short</code> value with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to read the message due to some internal error.</dd> |
| <dd><code><a href="../../javax/jms/MessageFormatException.html" title="class in javax.jms">MessageFormatException</a></code> - if this type conversion is invalid.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getChar-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChar</h4> |
| <pre>char getChar(java.lang.String name) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Returns the Unicode character value with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the Unicode character</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Unicode character value with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to read the message due to some internal error.</dd> |
| <dd><code><a href="../../javax/jms/MessageFormatException.html" title="class in javax.jms">MessageFormatException</a></code> - if this type conversion is invalid.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInt-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt</h4> |
| <pre>int getInt(java.lang.String name) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Returns the <code>int</code> value with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>int</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>int</code> value with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to read the message due to some internal error.</dd> |
| <dd><code><a href="../../javax/jms/MessageFormatException.html" title="class in javax.jms">MessageFormatException</a></code> - if this type conversion is invalid.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLong-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLong</h4> |
| <pre>long getLong(java.lang.String name) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Returns the <code>long</code> value with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>long</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>long</code> value with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to read the message due to some internal error.</dd> |
| <dd><code><a href="../../javax/jms/MessageFormatException.html" title="class in javax.jms">MessageFormatException</a></code> - if this type conversion is invalid.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFloat-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFloat</h4> |
| <pre>float getFloat(java.lang.String name) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Returns the <code>float</code> value with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>float</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>float</code> value with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to read the message due to some internal error.</dd> |
| <dd><code><a href="../../javax/jms/MessageFormatException.html" title="class in javax.jms">MessageFormatException</a></code> - if this type conversion is invalid.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDouble-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDouble</h4> |
| <pre>double getDouble(java.lang.String name) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Returns the <code>double</code> value with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>double</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>double</code> value with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to read the message due to some internal error.</dd> |
| <dd><code><a href="../../javax/jms/MessageFormatException.html" title="class in javax.jms">MessageFormatException</a></code> - if this type conversion is invalid.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getString-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getString</h4> |
| <pre>java.lang.String getString(java.lang.String name) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Returns the <code>String</code> value with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>String</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>String</code> value with the specified name; if there is no item by this name, a null value is returned</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to read the message due to some internal error.</dd> |
| <dd><code><a href="../../javax/jms/MessageFormatException.html" title="class in javax.jms">MessageFormatException</a></code> - if this type conversion is invalid.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBytes-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBytes</h4> |
| <pre>byte[] getBytes(java.lang.String name) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Returns the byte array value with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the byte array</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy of the byte array value with the specified name; if there is no item by this name, a null value is |
| returned.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to read the message due to some internal error.</dd> |
| <dd><code><a href="../../javax/jms/MessageFormatException.html" title="class in javax.jms">MessageFormatException</a></code> - if this type conversion is invalid.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getObject-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObject</h4> |
| <pre>java.lang.Object getObject(java.lang.String name) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Returns the value of the object with the specified name. |
| |
| <p> |
| This method can be used to return, in objectified format, an object in the Java programming language ("Java object") |
| that had been stored in the Map with the equivalent <code>setObject</code> method call, or its equivalent primitive |
| <code>set<I>type</I></code> method. |
| |
| <p> |
| Note that byte values are returned as <code>byte[]</code>, not <code>Byte[]</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the Java object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy of the Java object value with the specified name, in objectified format (for example, if the object |
| was set as an <code>int</code>, an <code>Integer</code> is returned); if there is no item by this name, a null value is |
| returned</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to read the message due to some internal error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMapNames--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMapNames</h4> |
| <pre>java.util.Enumeration getMapNames() |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Returns an <code>Enumeration</code> of all the names in the <code>MapMessage</code> object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an enumeration of all the names in this <code>MapMessage</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to read the message due to some internal error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setBoolean-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBoolean</h4> |
| <pre>void setBoolean(java.lang.String name, |
| boolean value) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Sets a <code>boolean</code> value with the specified name into the Map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>boolean</code></dd> |
| <dd><code>value</code> - the <code>boolean</code> value to set in the Map</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to write the message due to some internal error.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is null or if the name is an empty string.</dd> |
| <dd><code><a href="../../javax/jms/MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setByte-java.lang.String-byte-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setByte</h4> |
| <pre>void setByte(java.lang.String name, |
| byte value) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Sets a <code>byte</code> value with the specified name into the Map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>byte</code></dd> |
| <dd><code>value</code> - the <code>byte</code> value to set in the Map</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to write the message due to some internal error.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is null or if the name is an empty string.</dd> |
| <dd><code><a href="../../javax/jms/MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setShort-java.lang.String-short-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShort</h4> |
| <pre>void setShort(java.lang.String name, |
| short value) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Sets a <code>short</code> value with the specified name into the Map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>short</code></dd> |
| <dd><code>value</code> - the <code>short</code> value to set in the Map</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to write the message due to some internal error.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is null or if the name is an empty string.</dd> |
| <dd><code><a href="../../javax/jms/MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setChar-java.lang.String-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setChar</h4> |
| <pre>void setChar(java.lang.String name, |
| char value) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Sets a Unicode character value with the specified name into the Map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the Unicode character</dd> |
| <dd><code>value</code> - the Unicode character value to set in the Map</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to write the message due to some internal error.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is null or if the name is an empty string.</dd> |
| <dd><code><a href="../../javax/jms/MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInt-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInt</h4> |
| <pre>void setInt(java.lang.String name, |
| int value) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Sets an <code>int</code> value with the specified name into the Map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>int</code></dd> |
| <dd><code>value</code> - the <code>int</code> value to set in the Map</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to write the message due to some internal error.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is null or if the name is an empty string.</dd> |
| <dd><code><a href="../../javax/jms/MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLong-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLong</h4> |
| <pre>void setLong(java.lang.String name, |
| long value) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Sets a <code>long</code> value with the specified name into the Map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>long</code></dd> |
| <dd><code>value</code> - the <code>long</code> value to set in the Map</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to write the message due to some internal error.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is null or if the name is an empty string.</dd> |
| <dd><code><a href="../../javax/jms/MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFloat-java.lang.String-float-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFloat</h4> |
| <pre>void setFloat(java.lang.String name, |
| float value) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Sets a <code>float</code> value with the specified name into the Map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>float</code></dd> |
| <dd><code>value</code> - the <code>float</code> value to set in the Map</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to write the message due to some internal error.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is null or if the name is an empty string.</dd> |
| <dd><code><a href="../../javax/jms/MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDouble-java.lang.String-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDouble</h4> |
| <pre>void setDouble(java.lang.String name, |
| double value) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Sets a <code>double</code> value with the specified name into the Map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>double</code></dd> |
| <dd><code>value</code> - the <code>double</code> value to set in the Map</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to write the message due to some internal error.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is null or if the name is an empty string.</dd> |
| <dd><code><a href="../../javax/jms/MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setString-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setString</h4> |
| <pre>void setString(java.lang.String name, |
| java.lang.String value) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Sets a <code>String</code> value with the specified name into the Map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the <code>String</code></dd> |
| <dd><code>value</code> - the <code>String</code> value to set in the Map</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to write the message due to some internal error.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is null or if the name is an empty string.</dd> |
| <dd><code><a href="../../javax/jms/MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setBytes-java.lang.String-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBytes</h4> |
| <pre>void setBytes(java.lang.String name, |
| byte[] value) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Sets a byte array value with the specified name into the Map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the byte array</dd> |
| <dd><code>value</code> - the byte array value to set in the Map; the array is copied so that the value for <code>name</code> will not |
| be altered by future modifications</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to write the message due to some internal error.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is null, or if the name is an empty string.</dd> |
| <dd><code><a href="../../javax/jms/MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setBytes-java.lang.String-byte:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBytes</h4> |
| <pre>void setBytes(java.lang.String name, |
| byte[] value, |
| int offset, |
| int length) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Sets a portion of the byte array value with the specified name into the Map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the byte array</dd> |
| <dd><code>value</code> - the byte array value to set in the Map</dd> |
| <dd><code>offset</code> - the initial offset within the byte array</dd> |
| <dd><code>length</code> - the number of bytes to use</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to write the message due to some internal error.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is null or if the name is an empty string.</dd> |
| <dd><code><a href="../../javax/jms/MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setObject-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setObject</h4> |
| <pre>void setObject(java.lang.String name, |
| java.lang.Object value) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Sets an object value with the specified name into the Map. |
| |
| <p> |
| This method works only for the objectified primitive object types (<code>Integer</code>, <code>Double</code>, |
| <code>Long</code> ...), <code>String</code> objects, and byte arrays.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the Java object</dd> |
| <dd><code>value</code> - the Java object value to set in the Map</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to write the message due to some internal error.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is null or if the name is an empty string.</dd> |
| <dd><code><a href="../../javax/jms/MessageFormatException.html" title="class in javax.jms">MessageFormatException</a></code> - if the object is invalid.</dd> |
| <dd><code><a href="../../javax/jms/MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</a></code> - if the message is in read-only mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="itemExists-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>itemExists</h4> |
| <pre>boolean itemExists(java.lang.String name) |
| throws <a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></pre> |
| <div class="block">Indicates whether an item exists in this <code>MapMessage</code> object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the item to test</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the item exists</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jms/JMSException.html" title="class in javax.jms">JMSException</a></code> - if the JMS provider fails to determine if the item exists 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="../../javax/jms/JMSSessionMode.html" title="annotation in javax.jms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/jms/Message.html" title="interface in javax.jms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/jms/MapMessage.html" target="_top">Frames</a></li> |
| <li><a href="MapMessage.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> |
