content/releases/qpid-protonj2-1.0.0-M18/api/org/apache/qpid/protonj2/client/Delivery.html - qpid-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>Delivery (Qpid ProtonJ2 Parent 1.0.0-M18 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.qpid.protonj2.client, interface: Delivery">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/Delivery.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../help-doc.html#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <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="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.client</a></div>
 <h1 title="Interface Delivery" class="title">Interface Delivery</h1>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Delivery</span></div>
 <div class="block">Incoming Delivery type that provides access to the message and the delivery
  data along with methods for settling the delivery when processing completes.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#accept()" class="member-name-link">accept</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Accepts and settles the delivery.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#annotations()" class="member-name-link">annotations</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Decodes the <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> payload and returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> containing a copy
  of any associated <a href="../types/messaging/DeliveryAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>DeliveryAnnotations</code></a> that were transmitted with the <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>
  payload of this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)" class="member-name-link">disposition</a><wbr>(<a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;state,
  boolean&nbsp;settle)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Updates the DeliveryState, and optionally settle the delivery as well.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>&lt;E&gt;&nbsp;<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;E&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#message()" class="member-name-link">message</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Decode the <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> payload and return an <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> object.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#messageFormat()" class="member-name-link">messageFormat</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Gets the message format for the current delivery.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#modified(boolean,boolean)" class="member-name-link">modified</a><wbr>(boolean&nbsp;deliveryFailed,
  boolean&nbsp;undeliverableHere)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Modifies and settles the delivery.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#rawInputStream()" class="member-name-link">rawInputStream</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Create and return an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> that reads the raw payload bytes of the given <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#receiver()" class="member-name-link">receiver</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#reject(java.lang.String,java.lang.String)" class="member-name-link">reject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;condition,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Rejects and settles the delivery, sending supplied error information along
  with the rejection.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#release()" class="member-name-link">release</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Releases and settles the delivery.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#remoteSettled()" class="member-name-link">remoteSettled</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Gets whether the delivery was settled by the remote peer yet.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#remoteState()" class="member-name-link">remoteState</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Gets the current remote state for the delivery.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#settle()" class="member-name-link">settle</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Settles the delivery locally.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#settled()" class="member-name-link">settled</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#state()" class="member-name-link">state</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Gets the current local state for the delivery.</div>
 </div>
 </div>
 </div>
 </div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="receiver()">
 <h3>receiver</h3>
 <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span>&nbsp;<span class="element-name">receiver</span>()</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> that originated this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="message()">
 <h3>message</h3>
 <div class="member-signature"><span class="type-parameters">&lt;E&gt;</span>&nbsp;<span class="return-type"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;E&gt;</span>&nbsp;<span class="element-name">message</span>()
                 throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Decode the <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> payload and return an <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> object.
  <p>
  If the incoming message carried any delivery annotations they can be accessed via the
  <a href="#annotations()"><code>annotations()</code></a> method.  Re-sending the returned message will not also
  send the incoming delivery annotations, the sender must include them in the
  <a href="Sender.html#send(org.apache.qpid.protonj2.client.Message,java.util.Map)"><code>Sender.send(Message, Map)</code></a> call if they are to be forwarded onto the next recipient.
  <p>
  Calling this message claims the payload of the delivery for the returned <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> and
  excludes use of the <a href="#rawInputStream()"><code>rawInputStream()</code></a> method of the <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> object.  Calling
  the <a href="#rawInputStream()"><code>rawInputStream()</code></a> method after calling this method throws <a href="exceptions/ClientIllegalStateException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientIllegalStateException</code></a>.
  <p>
  Care should be taken if attempting to specify anything other than the wild card type for the body
  of the returned message as the wrong type specification can lead to an exception.</div>
 <dl class="notes">
 <dt>Type Parameters:</dt>
 <dd><code>E</code> - The type of message body that should be contained in the returned <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd>
 <dt>Returns:</dt>
 <dd>a <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance that wraps the decoded payload.</dd>
 <dt>Throws:</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 decoding the payload.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="rawInputStream()">
 <h3>rawInputStream</h3>
 <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a></span>&nbsp;<span class="element-name">rawInputStream</span>()
                     throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Create and return an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> that reads the raw payload bytes of the given <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>.
  <p>
  Calling this method claims the payload of the delivery for the returned <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> and excludes
  use of the <a href="#message()"><code>message()</code></a> and <a href="#annotations()"><code>annotations()</code></a> methods of the <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> object.  Closing
  the returned input stream discards any unread bytes from the delivery payload.  Calling the <a href="#message()"><code>message()</code></a>
  or <a href="#annotations()"><code>annotations()</code></a> methods after calling this method throws <a href="exceptions/ClientIllegalStateException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientIllegalStateException</code></a>.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> instance that can be used to read the raw delivery payload.</dd>
 <dt>Throws:</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 decoding the payload.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="annotations()">
 <h3>annotations</h3>
 <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</span>&nbsp;<span class="element-name">annotations</span>()
                         throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Decodes the <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> payload and returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> containing a copy
  of any associated <a href="../types/messaging/DeliveryAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>DeliveryAnnotations</code></a> that were transmitted with the <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>
  payload of this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>.
  <p>
  Calling this message claims the payload of the delivery for the returned <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> and the decoded
  <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that can be accessed via the <a href="#message()"><code>message()</code></a> method and  excludes use of the
  <a href="#rawInputStream()"><code>rawInputStream()</code></a> method of the <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> object.  Calling the <a href="#rawInputStream()"><code>rawInputStream()</code></a>
  method after calling this method throws <a href="exceptions/ClientIllegalStateException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientIllegalStateException</code></a>.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>copy of the delivery annotations that were transmitted with the <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> payload.</dd>
 <dt>Throws:</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 decoding the payload.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="accept()">
 <h3>accept</h3>
 <div class="member-signature"><span class="return-type"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></span>&nbsp;<span class="element-name">accept</span>()
          throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Accepts and settles the delivery.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> instance.</dd>
 <dt>Throws:</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 sending the disposition</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="release()">
 <h3>release</h3>
 <div class="member-signature"><span class="return-type"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></span>&nbsp;<span class="element-name">release</span>()
           throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Releases and settles the delivery.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> instance.</dd>
 <dt>Throws:</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 sending the disposition</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="reject(java.lang.String,java.lang.String)">
 <h3>reject</h3>
 <div class="member-signature"><span class="return-type"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></span>&nbsp;<span class="element-name">reject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;condition,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description)</span>
          throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Rejects and settles the delivery, sending supplied error information along
  with the rejection.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>condition</code> - The error condition value to supply with the rejection.</dd>
 <dd><code>description</code> - The error description value to supply with the rejection.</dd>
 <dt>Returns:</dt>
 <dd>this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> instance.</dd>
 <dt>Throws:</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 sending the disposition</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="modified(boolean,boolean)">
 <h3>modified</h3>
 <div class="member-signature"><span class="return-type"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></span>&nbsp;<span class="element-name">modified</span><wbr><span class="parameters">(boolean&nbsp;deliveryFailed,
  boolean&nbsp;undeliverableHere)</span>
            throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Modifies and settles the delivery.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>deliveryFailed</code> - Indicates if the modified delivery failed.</dd>
 <dd><code>undeliverableHere</code> - Indicates if the modified delivery should not be returned here again.</dd>
 <dt>Returns:</dt>
 <dd>this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> instance.</dd>
 <dt>Throws:</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 sending the disposition</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)">
 <h3>disposition</h3>
 <div class="member-signature"><span class="return-type"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></span>&nbsp;<span class="element-name">disposition</span><wbr><span class="parameters">(<a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;state,
  boolean&nbsp;settle)</span>
               throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Updates the DeliveryState, and optionally settle the delivery as well.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>state</code> - the delivery state to apply</dd>
 <dd><code>settle</code> - whether to <a href="#settle()"><code>settle()</code></a> the delivery at the same time</dd>
 <dt>Returns:</dt>
 <dd>this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> instance.</dd>
 <dt>Throws:</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 sending the disposition</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="settle()">
 <h3>settle</h3>
 <div class="member-signature"><span class="return-type"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></span>&nbsp;<span class="element-name">settle</span>()
          throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Settles the delivery locally.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the delivery</dd>
 <dt>Throws:</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 sending the disposition</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="settled()">
 <h3>settled</h3>
 <div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">settled</span>()
          throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>true if the delivery has been locally settled.</dd>
 <dt>Throws:</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 settled state</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="state()">
 <h3>state</h3>
 <div class="member-signature"><span class="return-type"><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></span>&nbsp;<span class="element-name">state</span>()
              throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Gets the current local state for the delivery.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the delivery state</dd>
 <dt>Throws:</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 delivery state</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="remoteState()">
 <h3>remoteState</h3>
 <div class="member-signature"><span class="return-type"><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></span>&nbsp;<span class="element-name">remoteState</span>()
                    throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Gets the current remote state for the delivery.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the remote delivery state</dd>
 <dt>Throws:</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 remote delivery state</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="remoteSettled()">
 <h3>remoteSettled</h3>
 <div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">remoteSettled</span>()
                throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Gets whether the delivery was settled by the remote peer yet.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>whether the delivery is remotely settled</dd>
 <dt>Throws:</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 remote settlement state</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="messageFormat()">
 <h3>messageFormat</h3>
 <div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">messageFormat</span>()
            throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div>
 <div class="block">Gets the message format for the current delivery.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the message format</dd>
 <dt>Throws:</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 delivery message format</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>