| <!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>ProtonJMessage (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="ProtonJMessage (Qpid Proton-J API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/qpid/proton/message/MessageError.html" title="enum in org.apache.qpid.proton.message"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/qpid/proton/message/ProtonJMessage.html" target="_top">Frames</a></li> |
| <li><a href="ProtonJMessage.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">org.apache.qpid.proton.message</div> |
| <h2 title="Interface ProtonJMessage" class="title">Interface ProtonJMessage</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/qpid/proton/message/Message.html" title="interface in org.apache.qpid.proton.message">Message</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">ProtonJMessage</span> |
| extends <a href="../../../../../org/apache/qpid/proton/message/Message.html" title="interface in org.apache.qpid.proton.message">Message</a></pre> |
| </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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.qpid.proton.message.Message"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.qpid.proton.message.<a href="../../../../../org/apache/qpid/proton/message/Message.html" title="interface in org.apache.qpid.proton.message">Message</a></h3> |
| <code><a href="../../../../../org/apache/qpid/proton/message/Message.Factory.html" title="class in org.apache.qpid.proton.message">Message.Factory</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== 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.org.apache.qpid.proton.message.Message"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.qpid.proton.message.<a href="../../../../../org/apache/qpid/proton/message/Message.html" title="interface in org.apache.qpid.proton.message">Message</a></h3> |
| <code><a href="../../../../../org/apache/qpid/proton/message/Message.html#DEFAULT_PRIORITY">DEFAULT_PRIORITY</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>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/ProtonJMessage.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="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/message/ProtonJMessage.html#encode2-byte:A-int-int-">encode2</a></span>(byte[] data, |
| int offset, |
| int length)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.message.Message"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.qpid.proton.message.<a href="../../../../../org/apache/qpid/proton/message/Message.html" title="interface in org.apache.qpid.proton.message">Message</a></h3> |
| <code><a href="../../../../../org/apache/qpid/proton/message/Message.html#clear--">clear</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#decode-byte:A-int-int-">decode</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#decode-org.apache.qpid.proton.codec.ReadableBuffer-">decode</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#encode-byte:A-int-int-">encode</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getAddress--">getAddress</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getApplicationProperties--">getApplicationProperties</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getBody--">getBody</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getContentEncoding--">getContentEncoding</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getContentType--">getContentType</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getCorrelationId--">getCorrelationId</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getCreationTime--">getCreationTime</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getDeliveryAnnotations--">getDeliveryAnnotations</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getDeliveryCount--">getDeliveryCount</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getError--">getError</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getExpiryTime--">getExpiryTime</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getFooter--">getFooter</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getGroupId--">getGroupId</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getGroupSequence--">getGroupSequence</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getHeader--">getHeader</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getMessageAnnotations--">getMessageAnnotations</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getMessageId--">getMessageId</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getPriority--">getPriority</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getProperties--">getProperties</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getReplyTo--">getReplyTo</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getReplyToGroupId--">getReplyToGroupId</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getSubject--">getSubject</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getTtl--">getTtl</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#getUserId--">getUserId</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#isDurable--">isDurable</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#isFirstAcquirer--">isFirstAcquirer</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setAddress-java.lang.String-">setAddress</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setApplicationProperties-org.apache.qpid.proton.amqp.messaging.ApplicationProperties-">setApplicationProperties</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setBody-org.apache.qpid.proton.amqp.messaging.Section-">setBody</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setContentEncoding-java.lang.String-">setContentEncoding</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setContentType-java.lang.String-">setContentType</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setCorrelationId-java.lang.Object-">setCorrelationId</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setCreationTime-long-">setCreationTime</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setDeliveryAnnotations-org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations-">setDeliveryAnnotations</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setDeliveryCount-long-">setDeliveryCount</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setDurable-boolean-">setDurable</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setExpiryTime-long-">setExpiryTime</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setFirstAcquirer-boolean-">setFirstAcquirer</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setFooter-org.apache.qpid.proton.amqp.messaging.Footer-">setFooter</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setGroupId-java.lang.String-">setGroupId</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setGroupSequence-long-">setGroupSequence</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setHeader-org.apache.qpid.proton.amqp.messaging.Header-">setHeader</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setMessageAnnotations-org.apache.qpid.proton.amqp.messaging.MessageAnnotations-">setMessageAnnotations</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setMessageId-java.lang.Object-">setMessageId</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setPriority-short-">setPriority</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setProperties-org.apache.qpid.proton.amqp.messaging.Properties-">setProperties</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setReplyTo-java.lang.String-">setReplyTo</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setReplyToGroupId-java.lang.String-">setReplyToGroupId</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setSubject-java.lang.String-">setSubject</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setTtl-long-">setTtl</a>, <a href="../../../../../org/apache/qpid/proton/message/Message.html#setUserId-byte:A-">setUserId</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="encode2-byte:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encode2</h4> |
| <pre>int encode2(byte[] data, |
| int offset, |
| int length)</pre> |
| </li> |
| </ul> |
| <a name="encode-org.apache.qpid.proton.codec.WritableBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/message/Message.html#encode-org.apache.qpid.proton.codec.WritableBuffer-">Message</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/qpid/proton/message/Message.html#encode-org.apache.qpid.proton.codec.WritableBuffer-">encode</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/message/Message.html" title="interface in org.apache.qpid.proton.message">Message</a></code></dd> |
| <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> |
| </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="../../../../../org/apache/qpid/proton/message/MessageError.html" title="enum in org.apache.qpid.proton.message"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/qpid/proton/message/ProtonJMessage.html" target="_top">Frames</a></li> |
| <li><a href="ProtonJMessage.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> |
