source: branches/objectmq-1.0/lib/rabbitmq-java-client-javadoc-3.0.1/com/rabbitmq/client/Command.html

Last change on this file was 33, checked in by amoreno, 11 years ago

new release version
File size: 10.2 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_18) on Tue Dec 11 11:47:09 GMT 2012 -->
6<TITLE>
7Command
8</TITLE>
9
10<META NAME="date" CONTENT="2012-12-11">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="Command";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47  </TR>
48</TABLE>
49</TD>
50<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51</EM>
52</TD>
53</TR>
54
55<TR>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57&nbsp;<A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
58&nbsp;<A HREF="../../../com/rabbitmq/client/ConfirmListener.html" title="interface in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
59<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60  <A HREF="../../../index.html?com/rabbitmq/client/Command.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="Command.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62&nbsp;<SCRIPT type="text/javascript">
63  <!--
64  if(window==top) {
65    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
66  }
67  //-->
68</SCRIPT>
69<NOSCRIPT>
70  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
71</NOSCRIPT>
72
73
74</FONT></TD>
75</TR>
76<TR>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
81</TR>
82</TABLE>
83<A NAME="skip-navbar_top"></A>
84<!-- ========= END OF TOP NAVBAR ========= -->
85
86<HR>
87<!-- ======== START OF CLASS DATA ======== -->
88<H2>
89<FONT SIZE="-1">
90com.rabbitmq.client</FONT>
91<BR>
92Interface Command</H2>
93<DL>
94<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/rabbitmq/client/impl/AMQCommand.html" title="class in com.rabbitmq.client.impl">AMQCommand</A></DD>
95</DL>
96<HR>
97<DL>
98<DT><PRE>public interface <B>Command</B></DL>
99</PRE>
100
101<P>
102Interface to a container for an AMQP method-and-arguments, with optional content header and body.
103<P>
104
105<P>
106<HR>
107
108<P>
109
110<!-- ========== METHOD SUMMARY =========== -->
111
112<A NAME="method_summary"><!-- --></A>
113<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
114<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
115<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
116<B>Method Summary</B></FONT></TH>
117</TR>
118<TR BGCOLOR="white" CLASS="TableRowColor">
119<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
120<CODE>&nbsp;byte[]</CODE></FONT></TD>
121<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Command.html#getContentBody()">getContentBody</A></B>()</CODE>
122
123<BR>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the body byte array that travelled as part of this
125 Command, if any.</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<CODE>&nbsp;<A HREF="../../../com/rabbitmq/client/ContentHeader.html" title="interface in com.rabbitmq.client">ContentHeader</A></CODE></FONT></TD>
130<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Command.html#getContentHeader()">getContentHeader</A></B>()</CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the ContentHeader subclass instance held as part of this Command, if any.</TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>&nbsp;<A HREF="../../../com/rabbitmq/client/Method.html" title="interface in com.rabbitmq.client">Method</A></CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Command.html#getMethod()">getMethod</A></B>()</CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the <A HREF="../../../com/rabbitmq/client/Method.html" title="interface in com.rabbitmq.client"><CODE>Method</CODE></A> held within this Command.</TD>
142</TR>
143</TABLE>
144&nbsp;
145<P>
146
147<!-- ============ METHOD DETAIL ========== -->
148
149<A NAME="method_detail"><!-- --></A>
150<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
151<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
152<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
153<B>Method Detail</B></FONT></TH>
154</TR>
155</TABLE>
156
157<A NAME="getMethod()"><!-- --></A><H3>
158getMethod</H3>
159<PRE>
160<A HREF="../../../com/rabbitmq/client/Method.html" title="interface in com.rabbitmq.client">Method</A> <B>getMethod</B>()</PRE>
161<DL>
162<DD>Retrieves the <A HREF="../../../com/rabbitmq/client/Method.html" title="interface in com.rabbitmq.client"><CODE>Method</CODE></A> held within this Command. Downcast to
163 concrete (implementation-specific!) subclasses as necessary.
164<P>
165<DD><DL>
166
167<DT><B>Returns:</B><DD>the command's method.</DL>
168</DD>
169</DL>
170<HR>
171
172<A NAME="getContentHeader()"><!-- --></A><H3>
173getContentHeader</H3>
174<PRE>
175<A HREF="../../../com/rabbitmq/client/ContentHeader.html" title="interface in com.rabbitmq.client">ContentHeader</A> <B>getContentHeader</B>()</PRE>
176<DL>
177<DD>Retrieves the ContentHeader subclass instance held as part of this Command, if any.
178
179 Downcast to one of the inner classes of AMQP,
180 for instance <A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client"><CODE>AMQP.BasicProperties</CODE></A>, as appropriate.
181<P>
182<DD><DL>
183
184<DT><B>Returns:</B><DD>the Command's <A HREF="../../../com/rabbitmq/client/ContentHeader.html" title="interface in com.rabbitmq.client"><CODE>ContentHeader</CODE></A>, or null if none</DL>
185</DD>
186</DL>
187<HR>
188
189<A NAME="getContentBody()"><!-- --></A><H3>
190getContentBody</H3>
191<PRE>
192byte[] <B>getContentBody</B>()</PRE>
193<DL>
194<DD>Retrieves the body byte array that travelled as part of this
195 Command, if any.
196<P>
197<DD><DL>
198
199<DT><B>Returns:</B><DD>the Command's content body, or null if none</DL>
200</DD>
201</DL>
202<!-- ========= END OF CLASS DATA ========= -->
203<HR>
204
205
206<!-- ======= START OF BOTTOM NAVBAR ====== -->
207<A NAME="navbar_bottom"><!-- --></A>
208<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
209<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
210<TR>
211<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
212<A NAME="navbar_bottom_firstrow"><!-- --></A>
213<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
214  <TR ALIGN="center" VALIGN="top">
215  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
216  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
217  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
218  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
219  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
220  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
221  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
222  </TR>
223</TABLE>
224</TD>
225<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
226</EM>
227</TD>
228</TR>
229
230<TR>
231<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
232&nbsp;<A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
233&nbsp;<A HREF="../../../com/rabbitmq/client/ConfirmListener.html" title="interface in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
234<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
235  <A HREF="../../../index.html?com/rabbitmq/client/Command.html" target="_top"><B>FRAMES</B></A>  &nbsp;
236&nbsp;<A HREF="Command.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
237&nbsp;<SCRIPT type="text/javascript">
238  <!--
239  if(window==top) {
240    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
241  }
242  //-->
243</SCRIPT>
244<NOSCRIPT>
245  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
246</NOSCRIPT>
247
248
249</FONT></TD>
250</TR>
251<TR>
252<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
253  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
254<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
255DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
256</TR>
257</TABLE>
258<A NAME="skip-navbar_bottom"></A>
259<!-- ======== END OF BOTTOM NAVBAR ======= -->
260
261<HR>
262
263</BODY>
264</HTML>
Note: See TracBrowser for help on using the repository browser.