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

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>DeliveryState (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: DeliveryState">
 <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/DeliveryState.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><a href="#nested-class-summary">Nested</a>&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 DeliveryState" class="title">Interface DeliveryState</h1>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="impl/ClientDeliveryState.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDeliveryState</a></code>, <code><a href="impl/ClientDeliveryState.ClientAccepted.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDeliveryState.ClientAccepted</a></code>, <code><a href="impl/ClientDeliveryState.ClientModified.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDeliveryState.ClientModified</a></code>, <code><a href="impl/ClientDeliveryState.ClientRejected.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDeliveryState.ClientRejected</a></code>, <code><a href="impl/ClientDeliveryState.ClientReleased.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDeliveryState.ClientReleased</a></code>, <code><a href="impl/ClientDeliveryState.ClientTransactional.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDeliveryState.ClientTransactional</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">DeliveryState</span></div>
 <div class="block">Conveys the outcome of a Delivery either incoming or outgoing.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <li>
 <section class="nested-class-summary" id="nested-class-summary">
 <h2>Nested Class Summary</h2>
 <div class="caption"><span>Nested Classes</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Interface</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static enum&nbsp;</code></div>
 <div class="col-second even-row-color"><code><a href="DeliveryState.Type.html" class="type-name-link" title="enum in org.apache.qpid.protonj2.client">DeliveryState.Type</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ========== 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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab1"><code>static <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-tab1"><code><a href="#accepted()" class="member-name-link">accepted</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DeliveryState.Type.html" title="enum in org.apache.qpid.protonj2.client">DeliveryState.Type</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getType()" class="member-name-link">getType</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-tab5"><code>default boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isAccepted()" class="member-name-link">isAccepted</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <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-tab1"><code><a href="#modified(boolean,boolean)" class="member-name-link">modified</a><wbr>(boolean&nbsp;failed,
  boolean&nbsp;undeliverable)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
 <div class="block">Create a new Modified outcome with the given failure state.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <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-tab1"><code><a href="#modified(boolean,boolean,java.util.Map)" class="member-name-link">modified</a><wbr>(boolean&nbsp;failed,
  boolean&nbsp;undeliverable,
  <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;&nbsp;annotations)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1">
 <div class="block">Create a new Modified outcome with the given failure state.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <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-tab1"><code><a href="#rejected(java.lang.String,java.lang.String)" class="member-name-link">rejected</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 odd-row-color method-summary-table method-summary-table-tab1">
 <div class="block">Create a new Rejected outcome with the given condition and description.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <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-tab1"><code><a href="#rejected(java.lang.String,java.lang.String,java.util.Map)" class="member-name-link">rejected</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,
  <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;&nbsp;info)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1">
 <div class="block">Create a new Rejected outcome with the given condition and description.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <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-tab1"><code><a href="#released()" class="member-name-link">released</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1">&nbsp;</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="getType()">
 <h3>getType</h3>
 <div class="member-signature"><span class="return-type"><a href="DeliveryState.Type.html" title="enum in org.apache.qpid.protonj2.client">DeliveryState.Type</a></span>&nbsp;<span class="element-name">getType</span>()</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the type that the given <a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client"><code>DeliveryState</code></a> represents.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="isAccepted()">
 <h3>isAccepted</h3>
 <div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isAccepted</span>()</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>true if the <a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client"><code>DeliveryState</code></a> represents an Accepted outcome.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="accepted()">
 <h3>accepted</h3>
 <div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></span>&nbsp;<span class="element-name">accepted</span>()</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>an instance of an AMQP Accepted delivery outcome.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="released()">
 <h3>released</h3>
 <div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></span>&nbsp;<span class="element-name">released</span>()</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>an instance of an AMQP Released delivery outcome.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="rejected(java.lang.String,java.lang.String)">
 <h3>rejected</h3>
 <div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></span>&nbsp;<span class="element-name">rejected</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></div>
 <div class="block">Create a new Rejected outcome with the given condition and description.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>condition</code> - the condition that lead to the rejected outcome.</dd>
 <dd><code>description</code> - a meaningful description of the reason for the rejection.</dd>
 <dt>Returns:</dt>
 <dd>an instance of an AMQP Rejected delivery outcome.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="rejected(java.lang.String,java.lang.String,java.util.Map)">
 <h3>rejected</h3>
 <div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></span>&nbsp;<span class="element-name">rejected</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,
  <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;&nbsp;info)</span></div>
 <div class="block">Create a new Rejected outcome with the given condition and description.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>condition</code> - the condition that lead to the rejected outcome.</dd>
 <dd><code>description</code> - a meaningful description of the reason for the rejection.</dd>
 <dd><code>info</code> - 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 additional information about the rejection.</dd>
 <dt>Returns:</dt>
 <dd>an instance of an AMQP Rejected delivery outcome.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="modified(boolean,boolean)">
 <h3>modified</h3>
 <div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></span>&nbsp;<span class="element-name">modified</span><wbr><span class="parameters">(boolean&nbsp;failed,
  boolean&nbsp;undeliverable)</span></div>
 <div class="block">Create a new Modified outcome with the given failure state.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>failed</code> - boolean indicating if delivery failed or not.</dd>
 <dd><code>undeliverable</code> - boolean indicating if the delivery cannot be sent to this receiver again.</dd>
 <dt>Returns:</dt>
 <dd>an instance of an AMQP Modified delivery outcome.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="modified(boolean,boolean,java.util.Map)">
 <h3>modified</h3>
 <div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></span>&nbsp;<span class="element-name">modified</span><wbr><span class="parameters">(boolean&nbsp;failed,
  boolean&nbsp;undeliverable,
  <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;&nbsp;annotations)</span></div>
 <div class="block">Create a new Modified outcome with the given failure state.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>failed</code> - boolean indicating if delivery failed or not.</dd>
 <dd><code>undeliverable</code> - boolean indicating if the delivery cannot be sent to this receiver again.</dd>
 <dd><code>annotations</code> - updated annotation for the delivery that this outcome applies to.</dd>
 <dt>Returns:</dt>
 <dd>an instance of an AMQP Modified delivery outcome.</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>