| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Message (Qpid Proton-J API)</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="Message (Qpid Proton-J API)"; |
| } |
| } |
| 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,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":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>Prev Class</li> |
| <li><a href="../../../../../org/apache/qpid/proton/message/Message.Factory.html" title="class in org.apache.qpid.proton.message"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/qpid/proton/message/Message.html" target="_top">Frames</a></li> |
| <li><a href="Message.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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">org.apache.qpid.proton.message</div> |
| <h2 title="Interface Message" class="title">Interface Message</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/qpid/proton/message/ProtonJMessage.html" title="interface in org.apache.qpid.proton.message">ProtonJMessage</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/qpid/proton/message/impl/MessageImpl.html" title="class in org.apache.qpid.proton.message.impl">MessageImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Message</span></pre> |
| <div class="block">Represents a Message within Proton. |
| |
| Create instances of Message using <a href="../../../../../org/apache/qpid/proton/message/Message.Factory.html" title="class in org.apache.qpid.proton.message"><code>Message.Factory</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.Factory.html" title="class in org.apache.qpid.proton.message">Message.Factory</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#DEFAULT_PRIORITY">DEFAULT_PRIORITY</a></span></code> </td> |
| </tr> |
| </table> |
| </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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#clear--">clear</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#decode-byte:A-int-int-">decode</a></span>(byte[] data, |
| int offset, |
| int length)</code> |
| <div class="block">TODO describe what happens if the data does not represent a complete message.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#decode-org.apache.qpid.proton.codec.ReadableBuffer-">decode</a></span>(<a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> buffer)</code> |
| <div class="block">Decodes the Message from the given <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#encode-byte:A-int-int-">encode</a></span>(byte[] data, |
| int offset, |
| int length)</code> |
| <div class="block">Encodes up to <code>length</code> bytes of the message into the provided byte array, |
| starting at position <code>offset</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#encode-org.apache.qpid.proton.codec.WritableBuffer-">encode</a></span>(<a href="../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a> buffer)</code> |
| <div class="block">Encodes the current Message contents into the given <a href="../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>WritableBuffer</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getAddress--">getAddress</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/messaging/ApplicationProperties.html" title="class in org.apache.qpid.proton.amqp.messaging">ApplicationProperties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getApplicationProperties--">getApplicationProperties</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/messaging/Section.html" title="interface in org.apache.qpid.proton.amqp.messaging">Section</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getBody--">getBody</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getContentEncoding--">getContentEncoding</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getContentType--">getContentType</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getCorrelationId--">getCorrelationId</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getCreationTime--">getCreationTime</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/messaging/DeliveryAnnotations.html" title="class in org.apache.qpid.proton.amqp.messaging">DeliveryAnnotations</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getDeliveryAnnotations--">getDeliveryAnnotations</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getDeliveryCount--">getDeliveryCount</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/message/MessageError.html" title="enum in org.apache.qpid.proton.message">MessageError</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getError--">getError</a></span>()</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getExpiryTime--">getExpiryTime</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/messaging/Footer.html" title="class in org.apache.qpid.proton.amqp.messaging">Footer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getFooter--">getFooter</a></span>()</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getGroupId--">getGroupId</a></span>()</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getGroupSequence--">getGroupSequence</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/messaging/Header.html" title="class in org.apache.qpid.proton.amqp.messaging">Header</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getHeader--">getHeader</a></span>()</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/messaging/MessageAnnotations.html" title="class in org.apache.qpid.proton.amqp.messaging">MessageAnnotations</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getMessageAnnotations--">getMessageAnnotations</a></span>()</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getMessageId--">getMessageId</a></span>()</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getPriority--">getPriority</a></span>()</code> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/messaging/Properties.html" title="class in org.apache.qpid.proton.amqp.messaging">Properties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getProperties--">getProperties</a></span>()</code> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getReplyTo--">getReplyTo</a></span>()</code> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getReplyToGroupId--">getReplyToGroupId</a></span>()</code> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getSubject--">getSubject</a></span>()</code> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getTtl--">getTtl</a></span>()</code> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#getUserId--">getUserId</a></span>()</code> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#isDurable--">isDurable</a></span>()</code> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#isFirstAcquirer--">isFirstAcquirer</a></span>()</code> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setAddress-java.lang.String-">setAddress</a></span>(java.lang.String to)</code> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setApplicationProperties-org.apache.qpid.proton.amqp.messaging.ApplicationProperties-">setApplicationProperties</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/ApplicationProperties.html" title="class in org.apache.qpid.proton.amqp.messaging">ApplicationProperties</a> applicationProperties)</code> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setBody-org.apache.qpid.proton.amqp.messaging.Section-">setBody</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/Section.html" title="interface in org.apache.qpid.proton.amqp.messaging">Section</a> body)</code> </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setContentEncoding-java.lang.String-">setContentEncoding</a></span>(java.lang.String contentEncoding)</code> </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setContentType-java.lang.String-">setContentType</a></span>(java.lang.String contentType)</code> </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setCorrelationId-java.lang.Object-">setCorrelationId</a></span>(java.lang.Object correlationId)</code> </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setCreationTime-long-">setCreationTime</a></span>(long creationTime)</code> </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setDeliveryAnnotations-org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations-">setDeliveryAnnotations</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/DeliveryAnnotations.html" title="class in org.apache.qpid.proton.amqp.messaging">DeliveryAnnotations</a> deliveryAnnotations)</code> </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setDeliveryCount-long-">setDeliveryCount</a></span>(long deliveryCount)</code> </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setDurable-boolean-">setDurable</a></span>(boolean durable)</code> </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setExpiryTime-long-">setExpiryTime</a></span>(long absoluteExpiryTime)</code> </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setFirstAcquirer-boolean-">setFirstAcquirer</a></span>(boolean firstAcquirer)</code> </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setFooter-org.apache.qpid.proton.amqp.messaging.Footer-">setFooter</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/Footer.html" title="class in org.apache.qpid.proton.amqp.messaging">Footer</a> footer)</code> </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setGroupId-java.lang.String-">setGroupId</a></span>(java.lang.String groupId)</code> </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setGroupSequence-long-">setGroupSequence</a></span>(long groupSequence)</code> </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setHeader-org.apache.qpid.proton.amqp.messaging.Header-">setHeader</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/Header.html" title="class in org.apache.qpid.proton.amqp.messaging">Header</a> header)</code> </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setMessageAnnotations-org.apache.qpid.proton.amqp.messaging.MessageAnnotations-">setMessageAnnotations</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/MessageAnnotations.html" title="class in org.apache.qpid.proton.amqp.messaging">MessageAnnotations</a> messageAnnotations)</code> </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setMessageId-java.lang.Object-">setMessageId</a></span>(java.lang.Object messageId)</code> </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setPriority-short-">setPriority</a></span>(short priority)</code> </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setProperties-org.apache.qpid.proton.amqp.messaging.Properties-">setProperties</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/Properties.html" title="class in org.apache.qpid.proton.amqp.messaging">Properties</a> properties)</code> </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setReplyTo-java.lang.String-">setReplyTo</a></span>(java.lang.String replyTo)</code> </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setReplyToGroupId-java.lang.String-">setReplyToGroupId</a></span>(java.lang.String replyToGroupId)</code> </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setSubject-java.lang.String-">setSubject</a></span>(java.lang.String subject)</code> </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setTtl-long-">setTtl</a></span>(long ttl)</code> </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/Message.html#setUserId-byte:A-">setUserId</a></span>(byte[] userId)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_PRIORITY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_PRIORITY</h4> |
| <pre>static final short DEFAULT_PRIORITY</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.qpid.proton.message.Message.DEFAULT_PRIORITY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isDurable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDurable</h4> |
| <pre>boolean isDurable()</pre> |
| </li> |
| </ul> |
| <a name="getDeliveryCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeliveryCount</h4> |
| <pre>long getDeliveryCount()</pre> |
| </li> |
| </ul> |
| <a name="getPriority--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPriority</h4> |
| <pre>short getPriority()</pre> |
| </li> |
| </ul> |
| <a name="isFirstAcquirer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFirstAcquirer</h4> |
| <pre>boolean isFirstAcquirer()</pre> |
| </li> |
| </ul> |
| <a name="getTtl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTtl</h4> |
| <pre>long getTtl()</pre> |
| </li> |
| </ul> |
| <a name="setDurable-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDurable</h4> |
| <pre>void setDurable(boolean durable)</pre> |
| </li> |
| </ul> |
| <a name="setTtl-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTtl</h4> |
| <pre>void setTtl(long ttl)</pre> |
| </li> |
| </ul> |
| <a name="setDeliveryCount-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeliveryCount</h4> |
| <pre>void setDeliveryCount(long deliveryCount)</pre> |
| </li> |
| </ul> |
| <a name="setFirstAcquirer-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFirstAcquirer</h4> |
| <pre>void setFirstAcquirer(boolean firstAcquirer)</pre> |
| </li> |
| </ul> |
| <a name="setPriority-short-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPriority</h4> |
| <pre>void setPriority(short priority)</pre> |
| </li> |
| </ul> |
| <a name="getMessageId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageId</h4> |
| <pre>java.lang.Object getMessageId()</pre> |
| </li> |
| </ul> |
| <a name="getGroupSequence--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGroupSequence</h4> |
| <pre>long getGroupSequence()</pre> |
| </li> |
| </ul> |
| <a name="getReplyToGroupId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReplyToGroupId</h4> |
| <pre>java.lang.String getReplyToGroupId()</pre> |
| </li> |
| </ul> |
| <a name="getCreationTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCreationTime</h4> |
| <pre>long getCreationTime()</pre> |
| </li> |
| </ul> |
| <a name="getAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAddress</h4> |
| <pre>java.lang.String getAddress()</pre> |
| </li> |
| </ul> |
| <a name="getUserId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUserId</h4> |
| <pre>byte[] getUserId()</pre> |
| </li> |
| </ul> |
| <a name="getReplyTo--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReplyTo</h4> |
| <pre>java.lang.String getReplyTo()</pre> |
| </li> |
| </ul> |
| <a name="getGroupId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGroupId</h4> |
| <pre>java.lang.String getGroupId()</pre> |
| </li> |
| </ul> |
| <a name="getContentType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentType</h4> |
| <pre>java.lang.String getContentType()</pre> |
| </li> |
| </ul> |
| <a name="getExpiryTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExpiryTime</h4> |
| <pre>long getExpiryTime()</pre> |
| </li> |
| </ul> |
| <a name="getCorrelationId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCorrelationId</h4> |
| <pre>java.lang.Object getCorrelationId()</pre> |
| </li> |
| </ul> |
| <a name="getContentEncoding--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentEncoding</h4> |
| <pre>java.lang.String getContentEncoding()</pre> |
| </li> |
| </ul> |
| <a name="getSubject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSubject</h4> |
| <pre>java.lang.String getSubject()</pre> |
| </li> |
| </ul> |
| <a name="setGroupSequence-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGroupSequence</h4> |
| <pre>void setGroupSequence(long groupSequence)</pre> |
| </li> |
| </ul> |
| <a name="setUserId-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUserId</h4> |
| <pre>void setUserId(byte[] userId)</pre> |
| </li> |
| </ul> |
| <a name="setCreationTime-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCreationTime</h4> |
| <pre>void setCreationTime(long creationTime)</pre> |
| </li> |
| </ul> |
| <a name="setSubject-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSubject</h4> |
| <pre>void setSubject(java.lang.String subject)</pre> |
| </li> |
| </ul> |
| <a name="setGroupId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGroupId</h4> |
| <pre>void setGroupId(java.lang.String groupId)</pre> |
| </li> |
| </ul> |
| <a name="setAddress-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAddress</h4> |
| <pre>void setAddress(java.lang.String to)</pre> |
| </li> |
| </ul> |
| <a name="setExpiryTime-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExpiryTime</h4> |
| <pre>void setExpiryTime(long absoluteExpiryTime)</pre> |
| </li> |
| </ul> |
| <a name="setReplyToGroupId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReplyToGroupId</h4> |
| <pre>void setReplyToGroupId(java.lang.String replyToGroupId)</pre> |
| </li> |
| </ul> |
| <a name="setContentEncoding-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentEncoding</h4> |
| <pre>void setContentEncoding(java.lang.String contentEncoding)</pre> |
| </li> |
| </ul> |
| <a name="setContentType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentType</h4> |
| <pre>void setContentType(java.lang.String contentType)</pre> |
| </li> |
| </ul> |
| <a name="setReplyTo-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReplyTo</h4> |
| <pre>void setReplyTo(java.lang.String replyTo)</pre> |
| </li> |
| </ul> |
| <a name="setCorrelationId-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCorrelationId</h4> |
| <pre>void setCorrelationId(java.lang.Object correlationId)</pre> |
| </li> |
| </ul> |
| <a name="setMessageId-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMessageId</h4> |
| <pre>void setMessageId(java.lang.Object messageId)</pre> |
| </li> |
| </ul> |
| <a name="getHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeader</h4> |
| <pre><a href="../../../../../org/apache/qpid/proton/amqp/messaging/Header.html" title="class in org.apache.qpid.proton.amqp.messaging">Header</a> getHeader()</pre> |
| </li> |
| </ul> |
| <a name="getDeliveryAnnotations--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeliveryAnnotations</h4> |
| <pre><a href="../../../../../org/apache/qpid/proton/amqp/messaging/DeliveryAnnotations.html" title="class in org.apache.qpid.proton.amqp.messaging">DeliveryAnnotations</a> getDeliveryAnnotations()</pre> |
| </li> |
| </ul> |
| <a name="getMessageAnnotations--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageAnnotations</h4> |
| <pre><a href="../../../../../org/apache/qpid/proton/amqp/messaging/MessageAnnotations.html" title="class in org.apache.qpid.proton.amqp.messaging">MessageAnnotations</a> getMessageAnnotations()</pre> |
| </li> |
| </ul> |
| <a name="getProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre><a href="../../../../../org/apache/qpid/proton/amqp/messaging/Properties.html" title="class in org.apache.qpid.proton.amqp.messaging">Properties</a> getProperties()</pre> |
| </li> |
| </ul> |
| <a name="getApplicationProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApplicationProperties</h4> |
| <pre><a href="../../../../../org/apache/qpid/proton/amqp/messaging/ApplicationProperties.html" title="class in org.apache.qpid.proton.amqp.messaging">ApplicationProperties</a> getApplicationProperties()</pre> |
| </li> |
| </ul> |
| <a name="getBody--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBody</h4> |
| <pre><a href="../../../../../org/apache/qpid/proton/amqp/messaging/Section.html" title="interface in org.apache.qpid.proton.amqp.messaging">Section</a> getBody()</pre> |
| </li> |
| </ul> |
| <a name="getFooter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFooter</h4> |
| <pre><a href="../../../../../org/apache/qpid/proton/amqp/messaging/Footer.html" title="class in org.apache.qpid.proton.amqp.messaging">Footer</a> getFooter()</pre> |
| </li> |
| </ul> |
| <a name="setHeader-org.apache.qpid.proton.amqp.messaging.Header-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeader</h4> |
| <pre>void setHeader(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/Header.html" title="class in org.apache.qpid.proton.amqp.messaging">Header</a> header)</pre> |
| </li> |
| </ul> |
| <a name="setDeliveryAnnotations-org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeliveryAnnotations</h4> |
| <pre>void setDeliveryAnnotations(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/DeliveryAnnotations.html" title="class in org.apache.qpid.proton.amqp.messaging">DeliveryAnnotations</a> deliveryAnnotations)</pre> |
| </li> |
| </ul> |
| <a name="setMessageAnnotations-org.apache.qpid.proton.amqp.messaging.MessageAnnotations-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMessageAnnotations</h4> |
| <pre>void setMessageAnnotations(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/MessageAnnotations.html" title="class in org.apache.qpid.proton.amqp.messaging">MessageAnnotations</a> messageAnnotations)</pre> |
| </li> |
| </ul> |
| <a name="setProperties-org.apache.qpid.proton.amqp.messaging.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperties</h4> |
| <pre>void setProperties(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/Properties.html" title="class in org.apache.qpid.proton.amqp.messaging">Properties</a> properties)</pre> |
| </li> |
| </ul> |
| <a name="setApplicationProperties-org.apache.qpid.proton.amqp.messaging.ApplicationProperties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setApplicationProperties</h4> |
| <pre>void setApplicationProperties(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/ApplicationProperties.html" title="class in org.apache.qpid.proton.amqp.messaging">ApplicationProperties</a> applicationProperties)</pre> |
| </li> |
| </ul> |
| <a name="setBody-org.apache.qpid.proton.amqp.messaging.Section-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBody</h4> |
| <pre>void setBody(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/Section.html" title="interface in org.apache.qpid.proton.amqp.messaging">Section</a> body)</pre> |
| </li> |
| </ul> |
| <a name="setFooter-org.apache.qpid.proton.amqp.messaging.Footer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFooter</h4> |
| <pre>void setFooter(<a href="../../../../../org/apache/qpid/proton/amqp/messaging/Footer.html" title="class in org.apache.qpid.proton.amqp.messaging">Footer</a> footer)</pre> |
| </li> |
| </ul> |
| <a name="decode-byte:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decode</h4> |
| <pre>int decode(byte[] data, |
| int offset, |
| int length)</pre> |
| <div class="block">TODO describe what happens if the data does not represent a complete message. |
| Currently this appears to leave the message in an unknown state.</div> |
| </li> |
| </ul> |
| <a name="decode-org.apache.qpid.proton.codec.ReadableBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decode</h4> |
| <pre>void decode(<a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> buffer)</pre> |
| <div class="block">Decodes the Message from the given <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>. |
| <p> |
| If the buffer given does not contain the fully encoded Message bytes for decode |
| this method will throw an exception to indicate the buffer underflow condition and |
| the message object will be left in an undefined state.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - A <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a> that contains the complete message bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encode-byte:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encode</h4> |
| <pre>int encode(byte[] data, |
| int offset, |
| int length)</pre> |
| <div class="block">Encodes up to <code>length</code> bytes of the message into the provided byte array, |
| starting at position <code>offset</code>. |
| |
| TODO describe what happens if length is smaller than the encoded form, Currently |
| Proton-J throws an exception. What does Proton-C do?</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes written to the byte array</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encode-org.apache.qpid.proton.codec.WritableBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encode</h4> |
| <pre>int encode(<a href="../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a> buffer)</pre> |
| <div class="block">Encodes the current Message contents into the given <a href="../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>WritableBuffer</code></a> instance. |
| <p> |
| This method attempts to encode all message data into the <a href="../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>WritableBuffer</code></a> and |
| if the buffer has insufficient space it will throw an exception to indicate the buffer |
| overflow condition. If successful the method returns the number of bytes written to |
| the provided buffer to fully encode the message.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - The <a href="../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>WritableBuffer</code></a> instance to encode the message contents into.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes written to fully encode the message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clear--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>void clear()</pre> |
| </li> |
| </ul> |
| <a name="getError--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getError</h4> |
| <pre><a href="../../../../../org/apache/qpid/proton/message/MessageError.html" title="enum in org.apache.qpid.proton.message">MessageError</a> getError()</pre> |
| </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>Prev Class</li> |
| <li><a href="../../../../../org/apache/qpid/proton/message/Message.Factory.html" title="class in org.apache.qpid.proton.message"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/qpid/proton/message/Message.html" target="_top">Frames</a></li> |
| <li><a href="Message.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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> |