| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ClientMessage (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <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="ClientMessage (Qpid ProtonJ2 Parent 1.0.0-M9 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":9,"i21":9,"i22":9,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ClientMessage.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.client.impl</a></div> |
| <h2 title="Class ClientMessage" class="title">Class ClientMessage<E></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.client.impl.ClientMessage<E></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>E</code> - the body type that the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> carries</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><E></code>, <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><E></code></dd> |
| </dl> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">ClientMessage<E></span> |
| extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><E></pre> |
| <div class="block">Client provided <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> implementation that is used when sending messages |
| from a <a href="ClientSender.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientSender</code></a> or when decoding an AMQP Transfer for which all frames have |
| arrived.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#absoluteExpiryTime()">absoluteExpiryTime</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#absoluteExpiryTime(long)">absoluteExpiryTime</a></span>​(long expiryTime)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the absolute expiration time value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addBodySection(org.apache.qpid.protonj2.types.messaging.Section)">addBodySection</a></span>​(<a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging">Section</a><?> bodySection)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds the given <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> to the internal collection of sections that will be sent |
| to the remote peer when this message is encoded.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#annotation(java.lang.String)">annotation</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the requested message annotation value from this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> if it exists |
| or returns null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#annotation(java.lang.String,java.lang.Object)">annotation</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the given message annotation value at the given key, replacing any previous value |
| that was assigned to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../types/messaging/MessageAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging">MessageAnnotations</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#annotations()">annotations</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the current <a href="../../types/messaging/MessageAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>MessageAnnotations</code></a> assigned to this message, if none was assigned yet |
| then this method returns <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#annotations(org.apache.qpid.protonj2.types.messaging.MessageAnnotations)">annotations</a></span>​(<a href="../../types/messaging/MessageAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging">MessageAnnotations</a> messageAnnotations)</code></th> |
| <td class="colLast"> |
| <div class="block">Assign or replace the <a href="../../types/messaging/MessageAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>MessageAnnotations</code></a> instance associated with this message.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../types/messaging/ApplicationProperties.html" title="class in org.apache.qpid.protonj2.types.messaging">ApplicationProperties</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applicationProperties()">applicationProperties</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the current <a href="../../types/messaging/ApplicationProperties.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>ApplicationProperties</code></a> assigned to this message, if none was assigned yet |
| then this method returns <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applicationProperties(org.apache.qpid.protonj2.types.messaging.ApplicationProperties)">applicationProperties</a></span>​(<a href="../../types/messaging/ApplicationProperties.html" title="class in org.apache.qpid.protonj2.types.messaging">ApplicationProperties</a> applicationProperties)</code></th> |
| <td class="colLast"> |
| <div class="block">Assign or replace the <a href="../../types/messaging/ApplicationProperties.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>ApplicationProperties</code></a> instance associated with this message.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="type parameter in ClientMessage">E</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#body()">body</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the body value that is conveyed in this message or null if no body was set locally |
| or sent from the remote if this is an incoming message.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#body(E)">body</a></span>​(<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the body value that is to be conveyed to the remote when this message is sent.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging">Section</a><?>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bodySections()">bodySections</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Create and return an unmodifiable <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> that contains the <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> instances |
| currently assigned to this message.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bodySections(java.util.Collection)">bodySections</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging">Section</a><?>> sections)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the body <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> instances to use when encoding this message.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearBodySections()">clearBodySections</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clears all current body <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> elements from the <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contentEncoding()">contentEncoding</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contentEncoding(java.lang.String)">contentEncoding</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> contentEncoding)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the contentEncoding value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contentType()">contentType</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contentType(java.lang.String)">contentType</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> contentType)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the contentType value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#correlationId()">correlationId</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#correlationId(java.lang.Object)">correlationId</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> correlationId)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the correlationId value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>static <V> <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create()">create</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an empty <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientMessage</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>static <V> <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(org.apache.qpid.protonj2.types.messaging.Section)">create</a></span>​(<a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging">Section</a><V> body)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientMessage</code></a> instance with the given body <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> value.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>static <V> <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAdvancedMessage()">createAdvancedMessage</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an empty <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientMessage</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#creationTime()">creationTime</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#creationTime(long)">creationTime</a></span>​(long createTime)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the creation time value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deliveryCount()">deliveryCount</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deliveryCount(long)">deliveryCount</a></span>​(long deliveryCount)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the value to assign to the delivery count field of this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#durable()">durable</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">For an message being sent this method returns the current state of the |
| durable flag on the message.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#durable(boolean)">durable</a></span>​(boolean durable)</code></th> |
| <td class="colLast"> |
| <div class="block">Controls if the message is marked as durable when sent.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encode(java.util.Map)">encode</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> deliveryAnnotations)</code></th> |
| <td class="colLast"> |
| <div class="block">Encodes the <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> for transmission by the client.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#firstAcquirer()">firstAcquirer</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#firstAcquirer(boolean)">firstAcquirer</a></span>​(boolean firstAcquirer)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the value to assign to the first acquirer field of this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#footer()">footer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the current <a href="../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Footer</code></a> assigned to this message, if none was assigned yet |
| then this method returns <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#footer(java.lang.String)">footer</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the requested footer value from this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> if it exists or returns |
| <code>null</code> otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#footer(java.lang.String,java.lang.Object)">footer</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the given footer value at the given key, replacing any previous value |
| that was assigned to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#footer(org.apache.qpid.protonj2.types.messaging.Footer)">footer</a></span>​(<a href="../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a> footer)</code></th> |
| <td class="colLast"> |
| <div class="block">Assign or replace the <a href="../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Footer</code></a> instance associated with this message.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forEachAnnotation(java.util.function.BiConsumer)">forEachAnnotation</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> action)</code></th> |
| <td class="colLast"> |
| <div class="block">Invokes the given <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>BiConsumer</code></a> on each message annotation entry carried in this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forEachBodySection(java.util.function.Consumer)">forEachBodySection</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a><<a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging">Section</a><?>> consumer)</code></th> |
| <td class="colLast"> |
| <div class="block">Performs the given action for each body <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> of the <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> until all |
| sections have been presented to the given <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>Consumer</code></a> or the consumer throws an exception.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forEachFooter(java.util.function.BiConsumer)">forEachFooter</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> action)</code></th> |
| <td class="colLast"> |
| <div class="block">Invokes the given <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>BiConsumer</code></a> on each footer entry carried in this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forEachProperty(java.util.function.BiConsumer)">forEachProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> action)</code></th> |
| <td class="colLast"> |
| <div class="block">Invokes the given <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>BiConsumer</code></a> on each application property entry carried in this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupId()">groupId</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupId(java.lang.String)">groupId</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> groupId)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the groupId value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupSequence()">groupSequence</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupSequence(int)">groupSequence</a></span>​(int groupSequence)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the group sequence value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasAnnotation(java.lang.String)">hasAnnotation</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Query the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> to determine if it carries the given message annotation key.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasAnnotations()">hasAnnotations</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Query the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> to determine if it carries any message annotations.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasFooter(java.lang.String)">hasFooter</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Query the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> to determine if it carries the given footer key.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasFooters()">hasFooters</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Query the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> to determine if it carries any footers.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasProperties()">hasProperties</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Query the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> to determine if it carries any application properties.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasProperty(java.lang.String)">hasProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Query the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> to determine if it carries the given application property key.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code><a href="../../types/messaging/Header.html" title="class in org.apache.qpid.protonj2.types.messaging">Header</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#header()">header</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the current <a href="../../types/messaging/Header.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Header</code></a> assigned to this message, if none was assigned yet |
| then this method returns <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#header(org.apache.qpid.protonj2.types.messaging.Header)">header</a></span>​(<a href="../../types/messaging/Header.html" title="class in org.apache.qpid.protonj2.types.messaging">Header</a> header)</code></th> |
| <td class="colLast"> |
| <div class="block">Assign or replace the <a href="../../types/messaging/Header.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Header</code></a> instance associated with this message.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#messageFormat()">messageFormat</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#messageFormat(int)">messageFormat</a></span>​(int messageFormat)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the message format to use when the message is sent.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#messageId()">messageId</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#messageId(java.lang.Object)">messageId</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> messageId)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the message Id value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#priority()">priority</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#priority(byte)">priority</a></span>​(byte priority)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the relative message priority.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code><a href="../../types/messaging/Properties.html" title="class in org.apache.qpid.protonj2.types.messaging">Properties</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties()">properties</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the current <a href="../../types/messaging/Properties.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Properties</code></a> assigned to this message, if none was assigned yet |
| then this method returns <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties(org.apache.qpid.protonj2.types.messaging.Properties)">properties</a></span>​(<a href="../../types/messaging/Properties.html" title="class in org.apache.qpid.protonj2.types.messaging">Properties</a> properties)</code></th> |
| <td class="colLast"> |
| <div class="block">Assign or replace the <a href="../../types/messaging/Properties.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Properties</code></a> instance associated with this message.</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#property(java.lang.String)">property</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the requested application property value from this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> if it exists |
| or returns null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#property(java.lang.String,java.lang.Object)">property</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the given application property value at the given key, replacing any previous value |
| that was assigned to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAnnotation(java.lang.String)">removeAnnotation</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes the given message annotation from the values carried in the message currently, if none |
| was present than this method returns <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFooter(java.lang.String)">removeFooter</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes the given footer from the values carried in the message currently, if none |
| was present than this method returns <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeProperty(java.lang.String)">removeProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes the given application property from the values carried in the message currently, if none |
| was present than this method returns <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replyTo()">replyTo</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replyTo(java.lang.String)">replyTo</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> replyTo)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the replyTo value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replyToGroupId()">replyToGroupId</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replyToGroupId(java.lang.String)">replyToGroupId</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> replyToGroupId)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the replyTo group Id value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subject()">subject</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subject(java.lang.String)">subject</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> subject)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the subject value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#timeToLive()">timeToLive</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code><a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#timeToLive(long)">timeToLive</a></span>​(long timeToLive)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the message time to live value.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#to()">to</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#to(java.lang.String)">to</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> to)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the 'to' value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toAdvancedMessage()">toAdvancedMessage</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Safely convert this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance into an <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> reference |
| which can offer more low level APIs to an experienced client user.</div> |
| </td> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#userId()">userId</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#userId(byte%5B%5D)">userId</a></span>​(byte[] userId)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the user Id value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="toAdvancedMessage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toAdvancedMessage</h4> |
| <pre class="methodSignature">public <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> toAdvancedMessage()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#toAdvancedMessage()">Message</a></code></span></div> |
| <div class="block">Safely convert this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance into an <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> reference |
| which can offer more low level APIs to an experienced client user. |
| <p> |
| The default implementation first checks if the current instance is already of the correct |
| type before performing a brute force conversion of the current message to the client's |
| own internal <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> implementation. Users should override this method |
| if the internal conversion implementation is insufficient to obtain the proper message |
| structure to encode a meaningful 'on the wire' encoding of their custom implementation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#toAdvancedMessage()">toAdvancedMessage</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> that contains this message's current state.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="create()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre class="methodSignature">public static <V> <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><V> create()</pre> |
| <div class="block">Creates an empty <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientMessage</code></a> instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>V</code> - The type of the body value carried in this message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new empty <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientMessage</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="create(org.apache.qpid.protonj2.types.messaging.Section)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre class="methodSignature">public static <V> <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><V> create​(<a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging">Section</a><V> body)</pre> |
| <div class="block">Creates an <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientMessage</code></a> instance with the given body <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> value.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>V</code> - The type of the body value carried in this message body section.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>body</code> - The body <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> to assign to the created message instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientMessage</code></a> instance with the given body.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createAdvancedMessage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAdvancedMessage</h4> |
| <pre class="methodSignature">public static <V> <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><V> createAdvancedMessage()</pre> |
| <div class="block">Creates an empty <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientMessage</code></a> instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>V</code> - The type of the body value carried in this message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new empty <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientMessage</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="durable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>durable</h4> |
| <pre class="methodSignature">public boolean durable()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#durable()">Message</a></code></span></div> |
| <div class="block">For an message being sent this method returns the current state of the |
| durable flag on the message. For a received message this method returns |
| the durable flag value at the time of sending (or false if not set) unless |
| the value is updated after being received by the receiver.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#durable()">durable</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the Message is marked as being durable</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="durable(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>durable</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> durable​(boolean durable)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#durable(boolean)">Message</a></code></span></div> |
| <div class="block">Controls if the message is marked as durable when sent.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#durable(boolean)">durable</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>durable</code> - value assigned to the durable flag for this message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="priority()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>priority</h4> |
| <pre class="methodSignature">public byte priority()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#priority()">priority</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently configured priority or the default if none set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="priority(byte)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>priority</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> priority​(byte priority)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#priority(byte)">Message</a></code></span></div> |
| <div class="block">Sets the relative message priority. Higher numbers indicate higher priority messages. |
| Messages with higher priorities MAY be delivered before those with lower priorities. |
| For a received message this overwrites any value that was set by the remote sender.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#priority(byte)">priority</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>priority</code> - The priority value to assign this message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="timeToLive()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>timeToLive</h4> |
| <pre class="methodSignature">public long timeToLive()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#timeToLive()">timeToLive</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently set Time To Live duration (milliseconds).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="timeToLive(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>timeToLive</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> timeToLive​(long timeToLive)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#timeToLive(long)">Message</a></code></span></div> |
| <div class="block">Sets the message time to live value. |
| <p> |
| The time to live duration in milliseconds for which the message is to be considered "live". |
| If this is set then a message expiration time will be computed based on the time of arrival |
| at an intermediary. Messages that live longer than their expiration time will be discarded |
| (or dead lettered). When a message is transmitted by an intermediary that was received with a |
| time to live, the transmitted message's header SHOULD contain a time to live that is computed |
| as the difference between the current time and the formerly computed message expiration time, |
| i.e., the reduced time to live, so that messages will eventually die if they end up in a |
| delivery loop.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#timeToLive(long)">timeToLive</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeToLive</code> - The time span in milliseconds that this message should remain live before being discarded.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="firstAcquirer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>firstAcquirer</h4> |
| <pre class="methodSignature">public boolean firstAcquirer()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#firstAcquirer()">firstAcquirer</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>if this message has been acquired by another link previously</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="firstAcquirer(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>firstAcquirer</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> firstAcquirer​(boolean firstAcquirer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#firstAcquirer(boolean)">Message</a></code></span></div> |
| <div class="block">Sets the value to assign to the first acquirer field of this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| If this value is true, then this message has not been acquired by any other link. If this |
| value is false, then this message MAY have previously been acquired by another link or links.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#firstAcquirer(boolean)">firstAcquirer</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>firstAcquirer</code> - The boolean value to assign to the first acquirer field of the message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deliveryCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deliveryCount</h4> |
| <pre class="methodSignature">public long deliveryCount()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#deliveryCount()">deliveryCount</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of failed delivery attempts that this message has been part of.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deliveryCount(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deliveryCount</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> deliveryCount​(long deliveryCount)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#deliveryCount(long)">Message</a></code></span></div> |
| <div class="block">Sets the value to assign to the delivery count field of this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| Delivery count is the number of unsuccessful previous attempts to deliver this message. |
| If this value is non-zero it can be taken as an indication that the delivery might be a |
| duplicate. On first delivery, the value is zero. It is incremented upon an outcome being |
| settled at the sender, according to rules defined for each outcome.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#deliveryCount(long)">deliveryCount</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deliveryCount</code> - The new delivery count value to assign to this message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="messageId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>messageId</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> messageId()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#messageId()">messageId</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently set Message ID or null if none set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="messageId(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>messageId</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> messageId​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> messageId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#messageId(java.lang.Object)">Message</a></code></span></div> |
| <div class="block">Sets the message Id value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| The message Id, if set, uniquely identifies a message within the message system. The message |
| producer is usually responsible for setting the message-id in such a way that it is assured to |
| be globally unique. A remote peer MAY discard a message as a duplicate if the value of the |
| message-id matches that of a previously received message sent to the same node.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#messageId(java.lang.Object)">messageId</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>messageId</code> - The message Id value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="userId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>userId</h4> |
| <pre class="methodSignature">public byte[] userId()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#userId()">userId</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently set User ID or null if none set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="userId(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>userId</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> userId​(byte[] userId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#userId(byte%5B%5D)">Message</a></code></span></div> |
| <div class="block">Sets the user Id value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| The identity of the user responsible for producing the message. The client sets this value, |
| and it MAY be authenticated by intermediaries.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#userId(byte%5B%5D)">userId</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>userId</code> - The user Id value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="to()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>to</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> to()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#to()">to</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently set 'To' address which indicates the intended destination of the message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="to(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>to</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> to​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> to)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#to(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Sets the 'to' value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| The to field identifies the node that is the intended destination of the message. On any given |
| transfer this might not be the node at the receiving end of the link.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#to(java.lang.String)">to</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>to</code> - The 'to' node value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="subject()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>subject</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> subject()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#subject()">subject</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently set subject metadata for this message or null if none set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="subject(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>subject</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> subject​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> subject)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#subject(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Sets the subject value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| A common field for summary information about the message content and purpose.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#subject(java.lang.String)">subject</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subject</code> - The subject node value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="replyTo()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replyTo</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> replyTo()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#replyTo()">replyTo</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configured address of the node where replies to this message should be sent, or null if not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="replyTo(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replyTo</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> replyTo​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> replyTo)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#replyTo(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Sets the replyTo value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| The address of the node to send replies to.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#replyTo(java.lang.String)">replyTo</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>replyTo</code> - The replyTo node value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="correlationId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>correlationId</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> correlationId()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#correlationId()">correlationId</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently assigned correlation ID or null if none set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="correlationId(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>correlationId</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> correlationId​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> correlationId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#correlationId(java.lang.Object)">Message</a></code></span></div> |
| <div class="block">Sets the correlationId value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| This is a client-specific id that can be used to mark or identify messages between clients.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#correlationId(java.lang.Object)">correlationId</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>correlationId</code> - The correlationId value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="contentType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contentType</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> contentType()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#contentType()">contentType</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the assigned content type value for the message body section or null if not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="contentType(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contentType</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> contentType​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> contentType)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#contentType(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Sets the contentType value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| The RFC-2046 MIME type for the message's application-data section (body). As per RFC-2046 this can |
| contain a charset parameter defining the character encoding used: e.g., 'text/plain; charset="utf-8"'. |
| <p> |
| For clarity, as per section 7.2.1 of RFC-2616, where the content type is unknown the content-type |
| SHOULD NOT be set. This allows the recipient the opportunity to determine the actual type. Where the |
| section is known to be truly opaque binary data, the content-type SHOULD be set to application/octet-stream. |
| <p> |
| When using an application-data section with a section code other than data, content-type SHOULD NOT be set.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#contentType(java.lang.String)">contentType</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>contentType</code> - The contentType value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="contentEncoding()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contentEncoding</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> contentEncoding()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#contentEncoding()">contentEncoding</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the assigned content encoding value for the message body section or null if not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="contentEncoding(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contentEncoding</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> contentEncoding​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> contentEncoding)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#contentEncoding(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Sets the contentEncoding value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| The content-encoding property is used as a modifier to the content-type. When present, its value |
| indicates what additional content encodings have been applied to the application-data, and thus what |
| decoding mechanisms need to be applied in order to obtain the media-type referenced by the content-type |
| header field. |
| <p> |
| Content-encoding is primarily used to allow a document to be compressed without losing the identity of |
| its underlying content type. |
| <p> |
| Content-encodings are to be interpreted as per section 3.5 of RFC 2616 [RFC2616]. Valid content-encodings |
| are registered at IANA [IANAHTTPPARAMS]. |
| <p> |
| The content-encoding MUST NOT be set when the application-data section is other than data. The binary |
| representation of all other application-data section types is defined completely in terms of the AMQP |
| type system. |
| <p> |
| Implementations MUST NOT use the identity encoding. Instead, implementations SHOULD NOT set this property. |
| Implementations SHOULD NOT use the compress encoding, except as to remain compatible with messages originally |
| sent with other protocols, e.g. HTTP or SMTP. |
| <p> |
| Implementations SHOULD NOT specify multiple content-encoding values except as to be compatible with messages |
| originally sent with other protocols, e.g. HTTP or SMTP. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#contentEncoding(java.lang.String)">contentEncoding</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>contentEncoding</code> - The contentEncoding value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="absoluteExpiryTime()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>absoluteExpiryTime</h4> |
| <pre class="methodSignature">public long absoluteExpiryTime()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#absoluteExpiryTime()">absoluteExpiryTime</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configured absolute time of expiration for this message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="absoluteExpiryTime(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>absoluteExpiryTime</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> absoluteExpiryTime​(long expiryTime)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#absoluteExpiryTime(long)">Message</a></code></span></div> |
| <div class="block">Sets the absolute expiration time value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| An absolute time when this message is considered to be expired.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#absoluteExpiryTime(long)">absoluteExpiryTime</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expiryTime</code> - The absolute expiration time value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="creationTime()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>creationTime</h4> |
| <pre class="methodSignature">public long creationTime()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#creationTime()">creationTime</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the absolute time of creation for this message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="creationTime(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>creationTime</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> creationTime​(long createTime)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#creationTime(long)">Message</a></code></span></div> |
| <div class="block">Sets the creation time value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| An absolute time when this message was created.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#creationTime(long)">creationTime</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>createTime</code> - The creation time value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="groupId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>groupId</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> groupId()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#groupId()">groupId</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the assigned group ID for this message or null if not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="groupId(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>groupId</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> groupId​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> groupId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#groupId(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Sets the groupId value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| Identifies the group the message belongs to.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#groupId(java.lang.String)">groupId</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>groupId</code> - The groupId value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="groupSequence()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>groupSequence</h4> |
| <pre class="methodSignature">public int groupSequence()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#groupSequence()">groupSequence</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the assigned group sequence for this message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="groupSequence(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>groupSequence</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> groupSequence​(int groupSequence)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#groupSequence(int)">Message</a></code></span></div> |
| <div class="block">Sets the group sequence value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| The relative position of this message within its group.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#groupSequence(int)">groupSequence</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>groupSequence</code> - The group sequence to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="replyToGroupId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replyToGroupId</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> replyToGroupId()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#replyToGroupId()">replyToGroupId</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the client-specific id used so that client can send replies to this message to a specific group.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="replyToGroupId(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replyToGroupId</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> replyToGroupId​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> replyToGroupId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#replyToGroupId(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Sets the replyTo group Id value to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>. |
| <p> |
| This is a client-specific id that is used so that client can send replies to this message |
| to a specific group.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#replyToGroupId(java.lang.String)">replyToGroupId</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>replyToGroupId</code> - The replyTo group Id to assign to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="annotation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>annotation</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> annotation​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#annotation(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Returns the requested message annotation value from this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> if it exists |
| or returns null otherwise.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#annotation(java.lang.String)">annotation</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key of the message annotation to query for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding message annotation value of null if none was carried in this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasAnnotation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasAnnotation</h4> |
| <pre class="methodSignature">public boolean hasAnnotation​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#hasAnnotation(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Query the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> to determine if it carries the given message annotation key.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#hasAnnotation(java.lang.String)">hasAnnotation</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key of the message annotation to query for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the Message carries the given message annotation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasAnnotations()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasAnnotations</h4> |
| <pre class="methodSignature">public boolean hasAnnotations()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#hasAnnotations()">Message</a></code></span></div> |
| <div class="block">Query the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> to determine if it carries any message annotations.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#hasAnnotations()">hasAnnotations</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the Message carries any message annotations.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeAnnotation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAnnotation</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> removeAnnotation​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#removeAnnotation(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Removes the given message annotation from the values carried in the message currently, if none |
| was present than this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#removeAnnotation(java.lang.String)">removeAnnotation</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key of the message annotation to query for removal.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the message annotation value that was previously assigned to that key.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="forEachAnnotation(java.util.function.BiConsumer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forEachAnnotation</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> forEachAnnotation​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> action)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#forEachAnnotation(java.util.function.BiConsumer)">Message</a></code></span></div> |
| <div class="block">Invokes the given <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>BiConsumer</code></a> on each message annotation entry carried in this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#forEachAnnotation(java.util.function.BiConsumer)">forEachAnnotation</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>action</code> - The action that will be invoked on each message annotation entry.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="annotation(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>annotation</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> annotation​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#annotation(java.lang.String,java.lang.Object)">Message</a></code></span></div> |
| <div class="block">Sets the given message annotation value at the given key, replacing any previous value |
| that was assigned to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#annotation(java.lang.String,java.lang.Object)">annotation</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The message annotation key where the value is to be assigned.</dd> |
| <dd><code>value</code> - The value to assign to the given message annotation key.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="property(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>property</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> property​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#property(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Returns the requested application property value from this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> if it exists |
| or returns null otherwise.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#property(java.lang.String)">property</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key of the application property to query for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding application property value of null if none was carried in this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasProperty</h4> |
| <pre class="methodSignature">public boolean hasProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#hasProperty(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Query the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> to determine if it carries the given application property key.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#hasProperty(java.lang.String)">hasProperty</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key of the application property to query for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the Message carries the given application property.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasProperties</h4> |
| <pre class="methodSignature">public boolean hasProperties()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#hasProperties()">Message</a></code></span></div> |
| <div class="block">Query the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> to determine if it carries any application properties.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#hasProperties()">hasProperties</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the Message carries any application properties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeProperty</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> removeProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#removeProperty(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Removes the given application property from the values carried in the message currently, if none |
| was present than this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#removeProperty(java.lang.String)">removeProperty</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key of the application property to query for removal.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the application property value that was previously assigned to that key.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="forEachProperty(java.util.function.BiConsumer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forEachProperty</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> forEachProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> action)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#forEachProperty(java.util.function.BiConsumer)">Message</a></code></span></div> |
| <div class="block">Invokes the given <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>BiConsumer</code></a> on each application property entry carried in this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#forEachProperty(java.util.function.BiConsumer)">forEachProperty</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>action</code> - The action that will be invoked on each application property entry.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="property(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>property</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> property​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#property(java.lang.String,java.lang.Object)">Message</a></code></span></div> |
| <div class="block">Sets the given application property value at the given key, replacing any previous value |
| that was assigned to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#property(java.lang.String,java.lang.Object)">property</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The application property key where the value is to be assigned.</dd> |
| <dd><code>value</code> - The value to assign to the given application property key.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="footer(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>footer</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> footer​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#footer(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Returns the requested footer value from this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> if it exists or returns |
| <code>null</code> otherwise.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#footer(java.lang.String)">footer</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key of the footer to query for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding footer value of null if none was carried in this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasFooter(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasFooter</h4> |
| <pre class="methodSignature">public boolean hasFooter​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#hasFooter(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Query the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> to determine if it carries the given footer key.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#hasFooter(java.lang.String)">hasFooter</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key of the footer to query for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the Message carries the given footer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasFooters()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasFooters</h4> |
| <pre class="methodSignature">public boolean hasFooters()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#hasFooters()">Message</a></code></span></div> |
| <div class="block">Query the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> to determine if it carries any footers.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#hasFooters()">hasFooters</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the Message carries any footers.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeFooter(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFooter</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> removeFooter​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#removeFooter(java.lang.String)">Message</a></code></span></div> |
| <div class="block">Removes the given footer from the values carried in the message currently, if none |
| was present than this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#removeFooter(java.lang.String)">removeFooter</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key of the footer to query for removal.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the footer value that was previously assigned to that key.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="forEachFooter(java.util.function.BiConsumer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forEachFooter</h4> |
| <pre class="methodSignature">public <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> forEachFooter​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> action)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#forEachFooter(java.util.function.BiConsumer)">Message</a></code></span></div> |
| <div class="block">Invokes the given <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>BiConsumer</code></a> on each footer entry carried in this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#forEachFooter(java.util.function.BiConsumer)">forEachFooter</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>action</code> - The action that will be invoked on each footer entry.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="footer(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>footer</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> footer​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#footer(java.lang.String,java.lang.Object)">Message</a></code></span></div> |
| <div class="block">Sets the given footer value at the given key, replacing any previous value |
| that was assigned to this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#footer(java.lang.String,java.lang.Object)">footer</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The footer key where the value is to be assigned.</dd> |
| <dd><code>value</code> - The value to assign to the given footer key.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="body()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>body</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="type parameter in ClientMessage">E</a> body()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#body()">Message</a></code></span></div> |
| <div class="block">Returns the body value that is conveyed in this message or null if no body was set locally |
| or sent from the remote if this is an incoming message.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#body()">body</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the message body value or null if none present.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="body(java.lang.Object)"> |
| <!-- --> |
| </a><a id="body(E)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>body</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> body​(<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a> value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Message.html#body(E)">Message</a></code></span></div> |
| <div class="block">Sets the body value that is to be conveyed to the remote when this message is sent. |
| <p> |
| The <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> implementation will choose the AMQP <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> to use to wrap |
| the given value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Message.html#body(E)">body</a></code> in interface <code><a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - The value to assign to the given message body <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="header()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>header</h4> |
| <pre class="methodSignature">public <a href="../../types/messaging/Header.html" title="class in org.apache.qpid.protonj2.types.messaging">Header</a> header()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#header()">AdvancedMessage</a></code></span></div> |
| <div class="block">Return the current <a href="../../types/messaging/Header.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Header</code></a> assigned to this message, if none was assigned yet |
| then this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#header()">header</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently assigned <a href="../../types/messaging/Header.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Header</code></a> for this message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="header(org.apache.qpid.protonj2.types.messaging.Header)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>header</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> header​(<a href="../../types/messaging/Header.html" title="class in org.apache.qpid.protonj2.types.messaging">Header</a> header)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#header(org.apache.qpid.protonj2.types.messaging.Header)">AdvancedMessage</a></code></span></div> |
| <div class="block">Assign or replace the <a href="../../types/messaging/Header.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Header</code></a> instance associated with this message.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#header(org.apache.qpid.protonj2.types.messaging.Header)">header</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>header</code> - The <a href="../../types/messaging/Header.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Header</code></a> value to assign to this message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="annotations()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>annotations</h4> |
| <pre class="methodSignature">public <a href="../../types/messaging/MessageAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging">MessageAnnotations</a> annotations()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#annotations()">AdvancedMessage</a></code></span></div> |
| <div class="block">Return the current <a href="../../types/messaging/MessageAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>MessageAnnotations</code></a> assigned to this message, if none was assigned yet |
| then this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#annotations()">annotations</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently assigned <a href="../../types/messaging/MessageAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>MessageAnnotations</code></a> for this message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="annotations(org.apache.qpid.protonj2.types.messaging.MessageAnnotations)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>annotations</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> annotations​(<a href="../../types/messaging/MessageAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging">MessageAnnotations</a> messageAnnotations)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#annotations(org.apache.qpid.protonj2.types.messaging.MessageAnnotations)">AdvancedMessage</a></code></span></div> |
| <div class="block">Assign or replace the <a href="../../types/messaging/MessageAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>MessageAnnotations</code></a> instance associated with this message.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#annotations(org.apache.qpid.protonj2.types.messaging.MessageAnnotations)">annotations</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>messageAnnotations</code> - The <a href="../../types/messaging/MessageAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>MessageAnnotations</code></a> value to assign to this message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="properties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>properties</h4> |
| <pre class="methodSignature">public <a href="../../types/messaging/Properties.html" title="class in org.apache.qpid.protonj2.types.messaging">Properties</a> properties()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#properties()">AdvancedMessage</a></code></span></div> |
| <div class="block">Return the current <a href="../../types/messaging/Properties.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Properties</code></a> assigned to this message, if none was assigned yet |
| then this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#properties()">properties</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently assigned <a href="../../types/messaging/Properties.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Properties</code></a> for this message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="properties(org.apache.qpid.protonj2.types.messaging.Properties)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>properties</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> properties​(<a href="../../types/messaging/Properties.html" title="class in org.apache.qpid.protonj2.types.messaging">Properties</a> properties)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#properties(org.apache.qpid.protonj2.types.messaging.Properties)">AdvancedMessage</a></code></span></div> |
| <div class="block">Assign or replace the <a href="../../types/messaging/Properties.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Properties</code></a> instance associated with this message.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#properties(org.apache.qpid.protonj2.types.messaging.Properties)">properties</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - The <a href="../../types/messaging/Properties.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Properties</code></a> value to assign to this message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="applicationProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applicationProperties</h4> |
| <pre class="methodSignature">public <a href="../../types/messaging/ApplicationProperties.html" title="class in org.apache.qpid.protonj2.types.messaging">ApplicationProperties</a> applicationProperties()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#applicationProperties()">AdvancedMessage</a></code></span></div> |
| <div class="block">Return the current <a href="../../types/messaging/ApplicationProperties.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>ApplicationProperties</code></a> assigned to this message, if none was assigned yet |
| then this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#applicationProperties()">applicationProperties</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently assigned <a href="../../types/messaging/ApplicationProperties.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>ApplicationProperties</code></a> for this message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="applicationProperties(org.apache.qpid.protonj2.types.messaging.ApplicationProperties)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applicationProperties</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> applicationProperties​(<a href="../../types/messaging/ApplicationProperties.html" title="class in org.apache.qpid.protonj2.types.messaging">ApplicationProperties</a> applicationProperties)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#applicationProperties(org.apache.qpid.protonj2.types.messaging.ApplicationProperties)">AdvancedMessage</a></code></span></div> |
| <div class="block">Assign or replace the <a href="../../types/messaging/ApplicationProperties.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>ApplicationProperties</code></a> instance associated with this message.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#applicationProperties(org.apache.qpid.protonj2.types.messaging.ApplicationProperties)">applicationProperties</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>applicationProperties</code> - The <a href="../../types/messaging/ApplicationProperties.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>ApplicationProperties</code></a> value to assign to this message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="footer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>footer</h4> |
| <pre class="methodSignature">public <a href="../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a> footer()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#footer()">AdvancedMessage</a></code></span></div> |
| <div class="block">Return the current <a href="../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Footer</code></a> assigned to this message, if none was assigned yet |
| then this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#footer()">footer</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently assigned <a href="../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Footer</code></a> for this message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="footer(org.apache.qpid.protonj2.types.messaging.Footer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>footer</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> footer​(<a href="../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a> footer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#footer(org.apache.qpid.protonj2.types.messaging.Footer)">AdvancedMessage</a></code></span></div> |
| <div class="block">Assign or replace the <a href="../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Footer</code></a> instance associated with this message.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#footer(org.apache.qpid.protonj2.types.messaging.Footer)">footer</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>footer</code> - The <a href="../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Footer</code></a> value to assign to this message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="messageFormat()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>messageFormat</h4> |
| <pre class="methodSignature">public int messageFormat()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#messageFormat()">messageFormat</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently assigned message format for this message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="messageFormat(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>messageFormat</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> messageFormat​(int messageFormat)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#messageFormat(int)">AdvancedMessage</a></code></span></div> |
| <div class="block">Sets the message format to use when the message is sent. The exact structure of a |
| message, together with its encoding, is defined by the message format (default is |
| the AMQP defined message format zero. |
| <p> |
| This field MUST be specified for the first transfer of a multi-transfer message, if |
| it is not set at the time of send of the first transfer the sender uses the AMQP |
| default value of zero for this field. |
| <p> |
| The upper three octets of a message format code identify a particular message format. |
| The lowest octet indicates the version of said message format. Any given version of |
| a format is forwards compatible with all higher versions. |
| <pre> |
| |
| 3 octets 1 octet |
| +----------------+---------+ |
| | message format | version | |
| +----------------+---------+ |
| | | |
| msb lsb |
| |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#messageFormat(int)">messageFormat</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>messageFormat</code> - The message format to encode into the transfer frame that carries the message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="encode(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encode</h4> |
| <pre class="methodSignature">public <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> encode​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> deliveryAnnotations) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#encode(java.util.Map)">AdvancedMessage</a></code></span></div> |
| <div class="block">Encodes the <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> for transmission by the client. The provided <a href="../../types/messaging/DeliveryAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>DeliveryAnnotations</code></a> |
| can be included or augmented by the <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> implementation based on the target message format. |
| The implementation is responsible for ensuring that the delivery annotations are treated correctly encoded into |
| the correct location in the message.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#encode(java.util.Map)">encode</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deliveryAnnotations</code> - A <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> of delivery annotation values that were requested to be included in the transmitted message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the encoded form of this message in a <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while encoding the message data.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addBodySection(org.apache.qpid.protonj2.types.messaging.Section)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addBodySection</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> addBodySection​(<a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging">Section</a><?> bodySection)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#addBodySection(org.apache.qpid.protonj2.types.messaging.Section)">AdvancedMessage</a></code></span></div> |
| <div class="block">Adds the given <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> to the internal collection of sections that will be sent |
| to the remote peer when this message is encoded. If a previous section was added by a call |
| to the <a href="../Message.html#body(E)"><code>Message.body(Object)</code></a> method it should be retained as the first element of |
| the running list of body sections contained in this message. |
| <p> |
| The implementation should make an attempt to validate that sections added are valid for |
| the message format that is assigned when they are added.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#addBodySection(org.apache.qpid.protonj2.types.messaging.Section)">addBodySection</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bodySection</code> - The <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> instance to append to the internal collection.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="bodySections(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bodySections</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> bodySections​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging">Section</a><?>> sections)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#bodySections(java.util.Collection)">AdvancedMessage</a></code></span></div> |
| <div class="block">Sets the body <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> instances to use when encoding this message. The value |
| given replaces any existing sections assigned to this message through the <a href="../Message.html#body(E)"><code>Message.body(Object)</code></a> |
| or <a href="../AdvancedMessage.html#addBodySection(org.apache.qpid.protonj2.types.messaging.Section)"><code>AdvancedMessage.addBodySection(Section)</code></a> methods. Calling this method with a null |
| or empty collection is equivalent to calling the <a href="../AdvancedMessage.html#clearBodySections()"><code>AdvancedMessage.clearBodySections()</code></a> method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#bodySections(java.util.Collection)">bodySections</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sections</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> of <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> instance to assign this message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="bodySections()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bodySections</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging">Section</a><?>> bodySections()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#bodySections()">AdvancedMessage</a></code></span></div> |
| <div class="block">Create and return an unmodifiable <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> that contains the <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> instances |
| currently assigned to this message. Changes to this message body after calling this will not be |
| reflected in the returned collection.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#bodySections()">bodySections</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an unmodifiable <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> that is a view of the current sections assigned to this message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="forEachBodySection(java.util.function.Consumer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forEachBodySection</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> forEachBodySection​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a><<a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging">Section</a><?>> consumer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#forEachBodySection(java.util.function.Consumer)">AdvancedMessage</a></code></span></div> |
| <div class="block">Performs the given action for each body <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> of the <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> until all |
| sections have been presented to the given <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>Consumer</code></a> or the consumer throws an exception.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#forEachBodySection(java.util.function.Consumer)">forEachBodySection</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consumer</code> - the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>Consumer</code></a> that will operate on each of the body sections in this message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clearBodySections()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>clearBodySections</h4> |
| <pre class="methodSignature">public <a href="ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>> clearBodySections()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../AdvancedMessage.html#clearBodySections()">AdvancedMessage</a></code></span></div> |
| <div class="block">Clears all current body <a href="../../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> elements from the <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../AdvancedMessage.html#clearBodySections()">clearBodySections</a></code> in interface <code><a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a><<a href="ClientMessage.html" title="type parameter in ClientMessage">E</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ClientMessage.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
