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

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>Delivery (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="Delivery (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":6,"i13":6,"i14":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <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/Delivery.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 Delivery" class="title">Interface Delivery</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <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>
 <pre>public interface <span class="typeNameLabel">Delivery</span></pre>
 <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>
 </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="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></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><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept()">accept</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Accepts and settles the delivery.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code><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;<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;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#annotations()">annotations</a></span>()</code></th>
 <td class="colLast">
 <div class="block">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?is-external=true" title="class or interface in java.util" class="externalLink"><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>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)">disposition</a></span>&#8203;(<a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;state,
            boolean&nbsp;settle)</code></th>
 <td class="colLast">
 <div class="block">Updates the DeliveryState, and optionally settle the delivery as well.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>&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="#message()">message</a></span>()</code></th>
 <td class="colLast">
 <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>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#messageFormat()">messageFormat</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Gets the message format for the current delivery.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#modified(boolean,boolean)">modified</a></span>&#8203;(boolean&nbsp;deliveryFailed,
         boolean&nbsp;undeliverableHere)</code></th>
 <td class="colLast">
 <div class="block">Modifies and settles the delivery.</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/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rawInputStream()">rawInputStream</a></span>()</code></th>
 <td class="colLast">
 <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?is-external=true" title="class or interface in java.io" class="externalLink"><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>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiver()">receiver</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reject(java.lang.String,java.lang.String)">reject</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;condition,
       <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;description)</code></th>
 <td class="colLast">
 <div class="block">Rejects and settles the delivery, sending supplied error information along
  with the rejection.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#release()">release</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Releases and settles the delivery.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteSettled()">remoteSettled</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Gets whether the delivery was settled by the remote peer yet.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteState()">remoteState</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Gets the current remote state for the delivery.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#settle()">settle</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Settles the delivery locally.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#settled()">settled</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#state()">state</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Gets the current local state for the delivery.</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="receiver()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>receiver</h4>
 <pre class="methodSignature"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&nbsp;receiver()</pre>
 <dl>
 <dt><span class="returnLabel">Returns:</span></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>
 </li>
 </ul>
 <a id="message()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>message</h4>
 <pre class="methodSignature">&lt;E&gt;&nbsp;<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;E&gt;&nbsp;message()
                 throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <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>
 <dt><span class="paramLabel">Type Parameters:</span></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><span class="returnLabel">Returns:</span></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><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 decoding the payload.</dd>
 </dl>
 </li>
 </ul>
 <a id="rawInputStream()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>rawInputStream</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;rawInputStream()
                     throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <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?is-external=true" title="class or interface in java.io" class="externalLink"><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?is-external=true" title="class or interface in java.io" class="externalLink"><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>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>InputStream</code></a> instance that can be used to read the raw delivery payload.</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 decoding the payload.</dd>
 </dl>
 </li>
 </ul>
 <a id="annotations()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>annotations</h4>
 <pre class="methodSignature"><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;<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;annotations()
                               throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <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?is-external=true" title="class or interface in java.util" class="externalLink"><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?is-external=true" title="class or interface in java.util" class="externalLink"><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>
 <dt><span class="returnLabel">Returns:</span></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><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 decoding the payload.</dd>
 </dl>
 </li>
 </ul>
 <a id="accept()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>accept</h4>
 <pre class="methodSignature"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a>&nbsp;accept()
          throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Accepts and settles the delivery.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</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 sending the disposition</dd>
 </dl>
 </li>
 </ul>
 <a id="release()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>release</h4>
 <pre class="methodSignature"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a>&nbsp;release()
           throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Releases and settles the delivery.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</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 sending the disposition</dd>
 </dl>
 </li>
 </ul>
 <a id="reject(java.lang.String,java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>reject</h4>
 <pre class="methodSignature"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a>&nbsp;reject&#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;condition,
                 <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;description)
          throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Rejects and settles the delivery, sending supplied error information along
  with the rejection.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
 <dd>this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</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 sending the disposition</dd>
 </dl>
 </li>
 </ul>
 <a id="modified(boolean,boolean)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>modified</h4>
 <pre class="methodSignature"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a>&nbsp;modified&#8203;(boolean&nbsp;deliveryFailed,
                   boolean&nbsp;undeliverableHere)
            throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Modifies and settles the delivery.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
 <dd>this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</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 sending the disposition</dd>
 </dl>
 </li>
 </ul>
 <a id="disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>disposition</h4>
 <pre class="methodSignature"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a>&nbsp;disposition&#8203;(<a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;state,
                      boolean&nbsp;settle)
               throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Updates the DeliveryState, and optionally settle the delivery as well.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
 <dd>this <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</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 sending the disposition</dd>
 </dl>
 </li>
 </ul>
 <a id="settle()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>settle</h4>
 <pre class="methodSignature"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a>&nbsp;settle()
          throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Settles the delivery locally.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the delivery</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 sending the disposition</dd>
 </dl>
 </li>
 </ul>
 <a id="settled()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>settled</h4>
 <pre class="methodSignature">boolean&nbsp;settled()
          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>true if the delivery has been locally settled.</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 settled state</dd>
 </dl>
 </li>
 </ul>
 <a id="state()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>state</h4>
 <pre class="methodSignature"><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;state()
              throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Gets the current local state for the delivery.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the delivery state</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 delivery state</dd>
 </dl>
 </li>
 </ul>
 <a id="remoteState()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>remoteState</h4>
 <pre class="methodSignature"><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;remoteState()
                    throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Gets the current remote state for the delivery.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the remote delivery state</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 remote delivery state</dd>
 </dl>
 </li>
 </ul>
 <a id="remoteSettled()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>remoteSettled</h4>
 <pre class="methodSignature">boolean&nbsp;remoteSettled()
                throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Gets whether the delivery was settled by the remote peer yet.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>whether the delivery is remotely settled</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 remote settlement state</dd>
 </dl>
 </li>
 </ul>
 <a id="messageFormat()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>messageFormat</h4>
 <pre class="methodSignature">int&nbsp;messageFormat()
            throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Gets the message format for the current delivery.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the message format</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 delivery message format</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/Delivery.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>