EVOLUTION-MANAGER
Edit File: Envelope.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_91) on Thu Jan 14 10:04:50 GMT 2016 --> <title>Envelope</title> <meta name="date" content="2016-01-14"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="Envelope"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../com/rabbitmq/client/DefaultSocketConfigurator.html" title="class in com.rabbitmq.client"><span class="strong">Prev Class</span></a></li> <li><a href="../../../com/rabbitmq/client/ExceptionHandler.html" title="interface in com.rabbitmq.client"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/rabbitmq/client/Envelope.html" target="_top">Frames</a></li> <li><a href="Envelope.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../allclasses-noframe.html">All 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> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">com.rabbitmq.client</div> <h2 title="Class Envelope" class="title">Class Envelope</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.rabbitmq.client.Envelope</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">Envelope</span> extends java.lang.Object</pre> <div class="block">Encapsulates a group of parameters used for AMQP's Basic methods</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../com/rabbitmq/client/Envelope.html#Envelope(long,%20boolean,%20java.lang.String,%20java.lang.String)">Envelope</a></strong>(long deliveryTag, boolean redeliver, java.lang.String exchange, java.lang.String routingKey)</code> <div class="block">Construct an <a href="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client"><code>Envelope</code></a> with the specified construction parameters</div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../com/rabbitmq/client/Envelope.html#getDeliveryTag()">getDeliveryTag</a></strong>()</code> <div class="block">Get the delivery tag included in this parameter envelope</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../com/rabbitmq/client/Envelope.html#getExchange()">getExchange</a></strong>()</code> <div class="block">Get the name of the exchange included in this parameter envelope</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../com/rabbitmq/client/Envelope.html#getRoutingKey()">getRoutingKey</a></strong>()</code> <div class="block">Get the routing key included in this parameter envelope</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../com/rabbitmq/client/Envelope.html#isRedeliver()">isRedeliver</a></strong>()</code> <div class="block">Get the redelivery flag included in this parameter envelope.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../com/rabbitmq/client/Envelope.html#toString()">toString</a></strong>()</code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="Envelope(long, boolean, java.lang.String, java.lang.String)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Envelope</h4> <pre>public Envelope(long deliveryTag, boolean redeliver, java.lang.String exchange, java.lang.String routingKey)</pre> <div class="block">Construct an <a href="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client"><code>Envelope</code></a> with the specified construction parameters</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>deliveryTag</code> - the delivery tag</dd><dd><code>redeliver</code> - true if this is a redelivery following a failed ack</dd><dd><code>exchange</code> - the exchange used for the current operation</dd><dd><code>routingKey</code> - the associated routing key</dd></dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getDeliveryTag()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDeliveryTag</h4> <pre>public long getDeliveryTag()</pre> <div class="block">Get the delivery tag included in this parameter envelope</div> <dl><dt><span class="strong">Returns:</span></dt><dd>the delivery tag</dd></dl> </li> </ul> <a name="isRedeliver()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isRedeliver</h4> <pre>public boolean isRedeliver()</pre> <div class="block">Get the redelivery flag included in this parameter envelope. This is a hint as to whether this message may have been delivered before (but not acknowledged). If the flag is not set, the message definitely has not been delivered before. If it is set, it may have been delivered before.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>the redelivery flag</dd></dl> </li> </ul> <a name="getExchange()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getExchange</h4> <pre>public java.lang.String getExchange()</pre> <div class="block">Get the name of the exchange included in this parameter envelope</div> <dl><dt><span class="strong">Returns:</span></dt><dd>the exchange</dd></dl> </li> </ul> <a name="getRoutingKey()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRoutingKey</h4> <pre>public java.lang.String getRoutingKey()</pre> <div class="block">Get the routing key included in this parameter envelope</div> <dl><dt><span class="strong">Returns:</span></dt><dd>the routing key</dd></dl> </li> </ul> <a name="toString()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../com/rabbitmq/client/DefaultSocketConfigurator.html" title="class in com.rabbitmq.client"><span class="strong">Prev Class</span></a></li> <li><a href="../../../com/rabbitmq/client/ExceptionHandler.html" title="interface in com.rabbitmq.client"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/rabbitmq/client/Envelope.html" target="_top">Frames</a></li> <li><a href="Envelope.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../allclasses-noframe.html">All 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> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>