Google Git
Sign in
apache / qpid-site / a52bbf4a24b0bdf923763f81d78481d22102177f / . / input / releases / qpid-protonj2-1.0.0-M9 / api / org / apache / qpid / protonj2 / client / DeliveryState.html
blob: 39e17f311f5cf09b1ef0fa915cc2cc20a5d689aa [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>DeliveryState (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="DeliveryState (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":1,"i1":6,"i2":18,"i3":1,"i4":1,"i5":1,"i6":1,"i7":1};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DeliveryState.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><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="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 DeliveryState" class="title">Interface DeliveryState</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/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>
<pre>public interface <span class="typeNameLabel">DeliveryState</span></pre>
<div class="block">Conveys the outcome of a Delivery either incoming or outgoing.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="DeliveryState.Type.html" title="enum in org.apache.qpid.protonj2.client">DeliveryState.Type</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <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="#accepted()">accepted</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="DeliveryState.Type.html" title="enum in org.apache.qpid.protonj2.client">DeliveryState.Type</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType()">getType</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAccepted()">isAccepted</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <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="#modified(boolean,boolean)">modified</a></span>&#8203;(boolean&nbsp;failed,
boolean&nbsp;undeliverable)</code></th>
<td class="colLast">
<div class="block">Create a new Modified outcome with the given failure state.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <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="#modified(boolean,boolean,java.util.Map)">modified</a></span>&#8203;(boolean&nbsp;failed,
boolean&nbsp;undeliverable,
<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)</code></th>
<td class="colLast">
<div class="block">Create a new Modified outcome with the given failure state.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <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="#rejected(java.lang.String,java.lang.String)">rejected</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">Create a new Rejected outcome with the given condition and description.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <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="#rejected(java.lang.String,java.lang.String,java.util.Map)">rejected</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,
<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;info)</code></th>
<td class="colLast">
<div class="block">Create a new Rejected outcome with the given condition and description.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <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="#released()">released</a></span>()</code></th>
<td class="colLast">&nbsp;</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="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre class="methodSignature"><a href="DeliveryState.Type.html" title="enum in org.apache.qpid.protonj2.client">DeliveryState.Type</a>&nbsp;getType()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></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>
</li>
</ul>
<a id="isAccepted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAccepted</h4>
<pre class="methodSignature">default&nbsp;boolean&nbsp;isAccepted()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></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>
</li>
</ul>
<a id="accepted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accepted</h4>
<pre class="methodSignature">static&nbsp;<a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;accepted()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of an AMQP Accepted delivery outcome.</dd>
</dl>
</li>
</ul>
<a id="released()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>released</h4>
<pre class="methodSignature">static&nbsp;<a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;released()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of an AMQP Released delivery outcome.</dd>
</dl>
</li>
</ul>
<a id="rejected(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rejected</h4>
<pre class="methodSignature">static&nbsp;<a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;rejected&#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)</pre>
<div class="block">Create a new Rejected outcome with the given condition and description.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>an instance of an AMQP Rejected delivery outcome.</dd>
</dl>
</li>
</ul>
<a id="rejected(java.lang.String,java.lang.String,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rejected</h4>
<pre class="methodSignature">static&nbsp;<a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;rejected&#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,
<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;info)</pre>
<div class="block">Create a new Rejected outcome with the given condition and description.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></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?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> containing additional information about the rejection.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of an AMQP Rejected delivery outcome.</dd>
</dl>
</li>
</ul>
<a id="modified(boolean,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>modified</h4>
<pre class="methodSignature">static&nbsp;<a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;modified&#8203;(boolean&nbsp;failed,
boolean&nbsp;undeliverable)</pre>
<div class="block">Create a new Modified outcome with the given failure state.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>an instance of an AMQP Modified delivery outcome.</dd>
</dl>
</li>
</ul>
<a id="modified(boolean,boolean,java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>modified</h4>
<pre class="methodSignature">static&nbsp;<a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;modified&#8203;(boolean&nbsp;failed,
boolean&nbsp;undeliverable,
<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)</pre>
<div class="block">Create a new Modified outcome with the given failure state.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>an instance of an AMQP Modified delivery outcome.</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/DeliveryState.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><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="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>