blob: c6b0f211996a5736706e1201b6e93955d0632f1c [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Message (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="Message (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":1,"i13":1,"i14":1,"i15":1,"i16":1,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":18,"i60":6,"i61":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/Message.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.client</a></div>
<h2 title="Interface Message" class="title">Interface Message&lt;E&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>E</code> - The type of the message body that this message carries</dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a>&lt;E&gt;</code>, <code><a href="StreamReceiverMessage.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiverMessage</a></code>, <code><a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client">StreamSenderMessage</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="impl/ClientMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientMessage</a></code>, <code><a href="impl/ClientStreamReceiverMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamReceiverMessage</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Message&lt;E&gt;</span></pre>
<div class="block">Message object that provides a high level abstraction to raw AMQP types</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</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">&nbsp;</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>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#absoluteExpiryTime(long)">absoluteExpiryTime</a></span>&#8203;(long&nbsp;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="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>&#8203;(<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>&nbsp;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="i3" class="rowColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#annotation(java.lang.String,java.lang.Object)">annotation</a></span>&#8203;(<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>&nbsp;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>&nbsp;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="i4" class="altColor">
<td class="colFirst"><code><a href="Message.html" title="type parameter in Message">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="i5" class="rowColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#body(E)">body</a></span>&#8203;(<a href="Message.html" title="type parameter in Message">E</a>&nbsp;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="i6" 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">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contentEncoding(java.lang.String)">contentEncoding</a></span>&#8203;(<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>&nbsp;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="i8" 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">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contentType(java.lang.String)">contentType</a></span>&#8203;(<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>&nbsp;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="i10" 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">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#correlationId(java.lang.Object)">correlationId</a></span>&#8203;(<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>&nbsp;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="i12" class="altColor">
<td class="colFirst"><code>static &lt;E&gt;&nbsp;<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;E&gt;</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">Create and return an <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that will carry no body <a href="../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a>
unless one is assigned by the caller.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;byte[]&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(byte%5B%5D)">create</a></span>&#8203;(byte[]&nbsp;body)</code></th>
<td class="colLast">
<div class="block">Create and return an <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that will wrap the given byte array in
an <a href="../types/messaging/Data.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Data</code></a> section.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static &lt;E&gt;&nbsp;<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;E&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(E)">create</a></span>&#8203;(E&nbsp;body)</code></th>
<td class="colLast">
<div class="block">Create and return an <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that will wrap the given <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"><code>Object</code></a> in
an <a href="../types/messaging/AmqpValue.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>AmqpValue</code></a> section.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static &lt;E&gt;&nbsp;<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;E&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.util.List)">create</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;E&gt;&nbsp;body)</code></th>
<td class="colLast">
<div class="block">Create and return an <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that will wrap the given <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>List</code></a> in
an <a href="../types/messaging/AmqpSequence.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>AmqpSequence</code></a> section.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static &lt;K,&#8203;V&gt;<br><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<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>&lt;K,&#8203;V&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.util.Map)">create</a></span>&#8203;(<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>&lt;K,&#8203;V&gt;&nbsp;body)</code></th>
<td class="colLast">
<div class="block">Create and return an <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that will wrap the given <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> in
an <a href="../types/messaging/AmqpValue.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>AmqpValue</code></a> section.</div>
</td>
</tr>
<tr id="i17" 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">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#creationTime(long)">creationTime</a></span>&#8203;(long&nbsp;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="i19" 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">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deliveryCount(long)">deliveryCount</a></span>&#8203;(long&nbsp;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="i21" 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="i22" class="altColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#durable(boolean)">durable</a></span>&#8203;(boolean&nbsp;durable)</code></th>
<td class="colLast">
<div class="block">Controls if the message is marked as durable when sent.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<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">&nbsp;</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>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#firstAcquirer(boolean)">firstAcquirer</a></span>&#8203;(boolean&nbsp;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="i25" 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>&#8203;(<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>&nbsp;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="i26" class="altColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#footer(java.lang.String,java.lang.Object)">footer</a></span>&#8203;(<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>&nbsp;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>&nbsp;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="i27" class="rowColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forEachAnnotation(java.util.function.BiConsumer)">forEachAnnotation</a></span>&#8203;(<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>&lt;<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>,&#8203;<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>&gt;&nbsp;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="i28" class="altColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forEachFooter(java.util.function.BiConsumer)">forEachFooter</a></span>&#8203;(<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>&lt;<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>,&#8203;<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>&gt;&nbsp;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="i29" class="rowColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forEachProperty(java.util.function.BiConsumer)">forEachProperty</a></span>&#8203;(<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>&lt;<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>,&#8203;<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>&gt;&nbsp;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="i30" 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">&nbsp;</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupId(java.lang.String)">groupId</a></span>&#8203;(<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>&nbsp;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="i32" 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">&nbsp;</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupSequence(int)">groupSequence</a></span>&#8203;(int&nbsp;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="i34" 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>&#8203;(<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>&nbsp;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="i35" 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="i36" 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>&#8203;(<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>&nbsp;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="i37" 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="i38" 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="i39" 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>&#8203;(<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>&nbsp;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="i40" 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">&nbsp;</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>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#messageId(java.lang.Object)">messageId</a></span>&#8203;(<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>&nbsp;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="i42" 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">&nbsp;</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>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#priority(byte)">priority</a></span>&#8203;(byte&nbsp;priority)</code></th>
<td class="colLast">
<div class="block">Sets the relative message priority.</div>
</td>
</tr>
<tr id="i44" 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>&#8203;(<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>&nbsp;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="i45" class="rowColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#property(java.lang.String,java.lang.Object)">property</a></span>&#8203;(<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>&nbsp;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>&nbsp;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="i46" 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>&#8203;(<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>&nbsp;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="i47" 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>&#8203;(<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>&nbsp;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="i48" 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>&#8203;(<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>&nbsp;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="i49" 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">&nbsp;</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replyTo(java.lang.String)">replyTo</a></span>&#8203;(<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>&nbsp;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="i51" 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">&nbsp;</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replyToGroupId(java.lang.String)">replyToGroupId</a></span>&#8203;(<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>&nbsp;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="i53" 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">&nbsp;</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subject(java.lang.String)">subject</a></span>&#8203;(<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>&nbsp;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="i55" 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">&nbsp;</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#timeToLive(long)">timeToLive</a></span>&#8203;(long&nbsp;timeToLive)</code></th>
<td class="colLast">
<div class="block">Sets the message time to live value.</div>
</td>
</tr>
<tr id="i57" 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">&nbsp;</td>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#to(java.lang.String)">to</a></span>&#8203;(<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>&nbsp;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="i59" class="rowColor">
<td class="colFirst"><code>default <a href="AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</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="i60" 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">&nbsp;</td>
</tr>
<tr id="i61" class="rowColor">
<td class="colFirst"><code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#userId(byte%5B%5D)">userId</a></span>&#8203;(byte[]&nbsp;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>
</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="create()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">static&nbsp;&lt;E&gt;&nbsp;<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;E&gt;&nbsp;create()</pre>
<div class="block">Create and return an <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that will carry no body <a href="../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a>
unless one is assigned by the caller.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>E</code> - The type that the message body should be treated as.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance with an empty body <a href="../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a>.</dd>
</dl>
</li>
</ul>
<a id="create(java.lang.Object)">
<!-- -->
</a><a id="create(E)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">static&nbsp;&lt;E&gt;&nbsp;<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;E&gt;&nbsp;create&#8203;(E&nbsp;body)</pre>
<div class="block">Create and return an <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that will wrap the given <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"><code>Object</code></a> in
an <a href="../types/messaging/AmqpValue.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>AmqpValue</code></a> section.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>E</code> - The type that the message body should be treated as.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - An object that will be wrapped in an <a href="../types/messaging/AmqpValue.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>AmqpValue</code></a> body section.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance with a body containing the given value.</dd>
</dl>
</li>
</ul>
<a id="create(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">static&nbsp;<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;byte[]&gt;&nbsp;create&#8203;(byte[]&nbsp;body)</pre>
<div class="block">Create and return an <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that will wrap the given byte array in
an <a href="../types/messaging/Data.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Data</code></a> section.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - An byte array that will be wrapped in an <a href="../types/messaging/Data.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Data</code></a> body section.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance with a body containing the given byte array.</dd>
</dl>
</li>
</ul>
<a id="create(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">static&nbsp;&lt;E&gt;&nbsp;<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;E&gt;&gt;&nbsp;create&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;E&gt;&nbsp;body)</pre>
<div class="block">Create and return an <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that will wrap the given <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>List</code></a> in
an <a href="../types/messaging/AmqpSequence.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>AmqpSequence</code></a> section.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>E</code> - The type that the List elements should be treated as.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - An List that will be wrapped in an <a href="../types/messaging/AmqpSequence.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>AmqpSequence</code></a> body section.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance with a body containing the given List.</dd>
</dl>
</li>
</ul>
<a id="create(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">static&nbsp;&lt;K,&#8203;V&gt;&nbsp;<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<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>&lt;K,&#8203;V&gt;&gt;&nbsp;create&#8203;(<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>&lt;K,&#8203;V&gt;&nbsp;body)</pre>
<div class="block">Create and return an <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that will wrap the given <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> in
an <a href="../types/messaging/AmqpValue.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>AmqpValue</code></a> section.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - the type that the <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> keys should be treated as.</dd>
<dd><code>V</code> - the type that the <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> values should be treated as.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - An Map that will be wrapped in an <a href="../types/messaging/AmqpValue.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>AmqpValue</code></a> body section.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance with a body containing the given Map.</dd>
</dl>
</li>
</ul>
<a id="toAdvancedMessage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toAdvancedMessage</h4>
<pre class="methodSignature">default&nbsp;<a href="AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;toAdvancedMessage()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if the <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> implementation cannot be converted</dd>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while converting the message to an <a href="AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>AdvancedMessage</code></a>/</dd>
</dl>
</li>
</ul>
<a id="durable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>durable</h4>
<pre class="methodSignature">boolean&nbsp;durable()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="returnLabel">Returns:</span></dt>
<dd>true if the Message is marked as being durable</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="durable(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>durable</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;durable&#8203;(boolean&nbsp;durable)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Controls if the message is marked as durable when sent.</div>
<dl>
<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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="priority()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>priority</h4>
<pre class="methodSignature">byte&nbsp;priority()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently configured priority or the default if none set.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="priority(byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>priority</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;priority&#8203;(byte&nbsp;priority)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="timeToLive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>timeToLive</h4>
<pre class="methodSignature">long&nbsp;timeToLive()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently set Time To Live duration (milliseconds).</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="timeToLive(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>timeToLive</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;timeToLive&#8203;(long&nbsp;timeToLive)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="firstAcquirer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>firstAcquirer</h4>
<pre class="methodSignature">boolean&nbsp;firstAcquirer()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if this message has been acquired by another link previously</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="firstAcquirer(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>firstAcquirer</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;firstAcquirer&#8203;(boolean&nbsp;firstAcquirer)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="deliveryCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deliveryCount</h4>
<pre class="methodSignature">long&nbsp;deliveryCount()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of failed delivery attempts that this message has been part of.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="deliveryCount(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deliveryCount</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;deliveryCount&#8203;(long&nbsp;deliveryCount)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="messageId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>messageId</h4>
<pre class="methodSignature"><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>&nbsp;messageId()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently set Message ID or null if none set.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="messageId(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>messageId</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;messageId&#8203;(<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>&nbsp;messageId)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="userId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>userId</h4>
<pre class="methodSignature">byte[]&nbsp;userId()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently set User ID or null if none set.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="userId(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>userId</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;userId&#8203;(byte[]&nbsp;userId)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="to()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>to</h4>
<pre class="methodSignature"><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>&nbsp;to()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently set 'To' address which indicates the intended destination of the message.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="to(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>to</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;to&#8203;(<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>&nbsp;to)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="subject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subject</h4>
<pre class="methodSignature"><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>&nbsp;subject()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently set subject metadata for this message or null if none set.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="subject(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subject</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;subject&#8203;(<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>&nbsp;subject)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="replyTo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replyTo</h4>
<pre class="methodSignature"><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>&nbsp;replyTo()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<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>
<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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="replyTo(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replyTo</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;replyTo&#8203;(<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>&nbsp;replyTo)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="correlationId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>correlationId</h4>
<pre class="methodSignature"><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>&nbsp;correlationId()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently assigned correlation ID or null if none set.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="correlationId(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>correlationId</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;correlationId&#8203;(<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>&nbsp;correlationId)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="contentType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentType</h4>
<pre class="methodSignature"><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>&nbsp;contentType()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the assigned content type value for the message body section or null if not set.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="contentType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentType</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;contentType&#8203;(<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>&nbsp;contentType)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="contentEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentEncoding</h4>
<pre class="methodSignature"><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>&nbsp;contentEncoding()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the assigned content encoding value for the message body section or null if not set.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="contentEncoding(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentEncoding</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;?&gt;&nbsp;contentEncoding&#8203;(<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>&nbsp;contentEncoding)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="absoluteExpiryTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>absoluteExpiryTime</h4>
<pre class="methodSignature">long&nbsp;absoluteExpiryTime()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured absolute time of expiration for this message.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="absoluteExpiryTime(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>absoluteExpiryTime</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;absoluteExpiryTime&#8203;(long&nbsp;expiryTime)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="creationTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>creationTime</h4>
<pre class="methodSignature">long&nbsp;creationTime()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the absolute time of creation for this message.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="creationTime(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>creationTime</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;creationTime&#8203;(long&nbsp;createTime)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="groupId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupId</h4>
<pre class="methodSignature"><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>&nbsp;groupId()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the assigned group ID for this message or null if not set.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="groupId(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupId</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;groupId&#8203;(<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>&nbsp;groupId)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="groupSequence()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupSequence</h4>
<pre class="methodSignature">int&nbsp;groupSequence()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the assigned group sequence for this message.</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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="groupSequence(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupSequence</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;groupSequence&#8203;(int&nbsp;groupSequence)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="replyToGroupId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replyToGroupId</h4>
<pre class="methodSignature"><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>&nbsp;replyToGroupId()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<dl>
<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>
<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 reading the given value.</dd>
</dl>
</li>
</ul>
<a id="replyToGroupId(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replyToGroupId</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;replyToGroupId&#8203;(<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>&nbsp;replyToGroupId)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 writing the given value.</dd>
</dl>
</li>
</ul>
<a id="annotation(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>annotation</h4>
<pre class="methodSignature"><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>&nbsp;annotation&#8203;(<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>&nbsp;key)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the message annotations 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">boolean&nbsp;hasAnnotation&#8203;(<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>&nbsp;key)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the message annotations in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
</dl>
</li>
</ul>
<a id="hasAnnotations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasAnnotations</h4>
<pre class="methodSignature">boolean&nbsp;hasAnnotations()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the Message carries any message annotations.</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 accessing the message annotations in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
</dl>
</li>
</ul>
<a id="removeAnnotation(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAnnotation</h4>
<pre class="methodSignature"><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>&nbsp;removeAnnotation&#8203;(<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>&nbsp;key)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the message annotations in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
</dl>
</li>
</ul>
<a id="forEachAnnotation(java.util.function.BiConsumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forEachAnnotation</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;forEachAnnotation&#8203;(<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>&lt;<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>,&#8203;<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>&gt;&nbsp;action)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the message annotations in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</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"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;annotation&#8203;(<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>&nbsp;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>&nbsp;value)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the message annotations in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
</dl>
</li>
</ul>
<a id="property(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>property</h4>
<pre class="methodSignature"><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>&nbsp;property&#8203;(<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>&nbsp;key)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the application properties in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</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"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;property&#8203;(<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>&nbsp;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>&nbsp;value)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the application properties 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">boolean&nbsp;hasProperty&#8203;(<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>&nbsp;key)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the application properties in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
</dl>
</li>
</ul>
<a id="hasProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasProperties</h4>
<pre class="methodSignature">boolean&nbsp;hasProperties()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the Message carries any application properties.</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 accessing the application properties in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
</dl>
</li>
</ul>
<a id="removeProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeProperty</h4>
<pre class="methodSignature"><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>&nbsp;removeProperty&#8203;(<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>&nbsp;key)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the application properties in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
</dl>
</li>
</ul>
<a id="forEachProperty(java.util.function.BiConsumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forEachProperty</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;forEachProperty&#8203;(<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>&lt;<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>,&#8203;<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>&gt;&nbsp;action)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the application properties in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
</dl>
</li>
</ul>
<a id="footer(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>footer</h4>
<pre class="methodSignature"><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>&nbsp;footer&#8203;(<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>&nbsp;key)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the footers 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">boolean&nbsp;hasFooter&#8203;(<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>&nbsp;key)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the footers in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
</dl>
</li>
</ul>
<a id="hasFooters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasFooters</h4>
<pre class="methodSignature">boolean&nbsp;hasFooters()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the Message carries any footers.</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 accessing the footers in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
</dl>
</li>
</ul>
<a id="removeFooter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFooter</h4>
<pre class="methodSignature"><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>&nbsp;removeFooter&#8203;(<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>&nbsp;key)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the footers in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
</dl>
</li>
</ul>
<a id="forEachFooter(java.util.function.BiConsumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forEachFooter</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;forEachFooter&#8203;(<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>&lt;<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>,&#8203;<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>&gt;&nbsp;action)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the footers in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</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"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;footer&#8203;(<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>&nbsp;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>&nbsp;value)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 accessing the footers in this <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
</dl>
</li>
</ul>
<a id="body()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>body</h4>
<pre class="methodSignature"><a href="Message.html" title="type parameter in Message">E</a>&nbsp;body()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="returnLabel">Returns:</span></dt>
<dd>the message body value or null if none present.</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 the implementation can't provide a body for some reason.</dd>
</dl>
</li>
</ul>
<a id="body(java.lang.Object)">
<!-- -->
</a><a id="body(E)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>body</h4>
<pre class="methodSignature"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="Message.html" title="type parameter in Message">E</a>&gt;&nbsp;body&#8203;(<a href="Message.html" title="type parameter in Message">E</a>&nbsp;value)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<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="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>
<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 the implementation cannot write to the body section for some reason..</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/Message.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>