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

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

new release version
File size: 11.1 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>
7LongString
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="LongString";
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/JDKSaslConfig.html" title="class in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
58&nbsp;<A HREF="../../../com/rabbitmq/client/MalformedFrameException.html" title="class 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/LongString.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="LongString.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&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 LongString</H2>
93<HR>
94<DL>
95<DT><PRE>public interface <B>LongString</B></DL>
96</PRE>
97
98<P>
99An object providing access to a LongString.
100 This might be implemented to read directly from connection
101 socket, depending on the size of the content to be read -
102 long strings may contain up to 4Gb of content.
103<P>
104
105<P>
106<HR>
107
108<P>
109<!-- =========== FIELD SUMMARY =========== -->
110
111<A NAME="field_summary"><!-- --></A>
112<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
113<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
114<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
115<B>Field Summary</B></FONT></TH>
116</TR>
117<TR BGCOLOR="white" CLASS="TableRowColor">
118<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
119<CODE>static&nbsp;long</CODE></FONT></TD>
120<TD><CODE><B><A HREF="../../../com/rabbitmq/client/LongString.html#MAX_LENGTH">MAX_LENGTH</A></B></CODE>
121
122<BR>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
124</TR>
125</TABLE>
126&nbsp;
127<!-- ========== METHOD SUMMARY =========== -->
128
129<A NAME="method_summary"><!-- --></A>
130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
132<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
133<B>Method Summary</B></FONT></TH>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>&nbsp;byte[]</CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../com/rabbitmq/client/LongString.html#getBytes()">getBytes</A></B>()</CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the content as a byte array.</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>&nbsp;java.io.DataInputStream</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../com/rabbitmq/client/LongString.html#getStream()">getStream</A></B>()</CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the content stream.</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>&nbsp;long</CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../com/rabbitmq/client/LongString.html#length()">length</A></B>()</CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
158</TR>
159</TABLE>
160&nbsp;
161<P>
162
163<!-- ============ FIELD DETAIL =========== -->
164
165<A NAME="field_detail"><!-- --></A>
166<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
167<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
168<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
169<B>Field Detail</B></FONT></TH>
170</TR>
171</TABLE>
172
173<A NAME="MAX_LENGTH"><!-- --></A><H3>
174MAX_LENGTH</H3>
175<PRE>
176static final long <B>MAX_LENGTH</B></PRE>
177<DL>
178<DL>
179<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.rabbitmq.client.LongString.MAX_LENGTH">Constant Field Values</A></DL>
180</DL>
181
182<!-- ============ METHOD DETAIL ========== -->
183
184<A NAME="method_detail"><!-- --></A>
185<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
186<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
187<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
188<B>Method Detail</B></FONT></TH>
189</TR>
190</TABLE>
191
192<A NAME="length()"><!-- --></A><H3>
193length</H3>
194<PRE>
195long <B>length</B>()</PRE>
196<DL>
197<DD><DL>
198
199<DT><B>Returns:</B><DD>the length of the <A HREF="../../../com/rabbitmq/client/LongString.html" title="interface in com.rabbitmq.client"><CODE>LongString</CODE></A> in bytes >= 0 <= MAX_LENGTH</DL>
200</DD>
201</DL>
202<HR>
203
204<A NAME="getStream()"><!-- --></A><H3>
205getStream</H3>
206<PRE>
207java.io.DataInputStream <B>getStream</B>()
208                                  throws java.io.IOException</PRE>
209<DL>
210<DD>Get the content stream.
211 Repeated calls to this function return the same stream,
212 which may not support rewind.
213<P>
214<DD><DL>
215
216<DT><B>Returns:</B><DD>An input stream that reads the content of the <A HREF="../../../com/rabbitmq/client/LongString.html" title="interface in com.rabbitmq.client"><CODE>LongString</CODE></A>
217<DT><B>Throws:</B>
218<DD><CODE>java.io.IOException</CODE> - if an error is encountered</DL>
219</DD>
220</DL>
221<HR>
222
223<A NAME="getBytes()"><!-- --></A><H3>
224getBytes</H3>
225<PRE>
226byte[] <B>getBytes</B>()</PRE>
227<DL>
228<DD>Get the content as a byte array.  This need not be a copy. Updates to the
229 returned array may change the value of the <A HREF="../../../com/rabbitmq/client/LongString.html" title="interface in com.rabbitmq.client"><CODE>LongString</CODE></A>.
230 Repeated calls to this function may return the same array.
231 This function will fail if <code><b>this</b>.length() > Integer.MAX_VALUE</code>,
232 throwing an <CODE>IllegalStateException</CODE>.
233<P>
234<DD><DL>
235
236<DT><B>Returns:</B><DD>the array of bytes containing the content of the <A HREF="../../../com/rabbitmq/client/LongString.html" title="interface in com.rabbitmq.client"><CODE>LongString</CODE></A></DL>
237</DD>
238</DL>
239<!-- ========= END OF CLASS DATA ========= -->
240<HR>
241
242
243<!-- ======= START OF BOTTOM NAVBAR ====== -->
244<A NAME="navbar_bottom"><!-- --></A>
245<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
246<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
247<TR>
248<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
249<A NAME="navbar_bottom_firstrow"><!-- --></A>
250<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
251  <TR ALIGN="center" VALIGN="top">
252  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
253  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
254  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
255  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
256  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
257  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
258  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
259  </TR>
260</TABLE>
261</TD>
262<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
263</EM>
264</TD>
265</TR>
266
267<TR>
268<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
269&nbsp;<A HREF="../../../com/rabbitmq/client/JDKSaslConfig.html" title="class in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
270&nbsp;<A HREF="../../../com/rabbitmq/client/MalformedFrameException.html" title="class in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
271<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
272  <A HREF="../../../index.html?com/rabbitmq/client/LongString.html" target="_top"><B>FRAMES</B></A>  &nbsp;
273&nbsp;<A HREF="LongString.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
274&nbsp;<SCRIPT type="text/javascript">
275  <!--
276  if(window==top) {
277    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
278  }
279  //-->
280</SCRIPT>
281<NOSCRIPT>
282  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
283</NOSCRIPT>
284
285
286</FONT></TD>
287</TR>
288<TR>
289<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
290  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
291<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
292DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
293</TR>
294</TABLE>
295<A NAME="skip-navbar_bottom"></A>
296<!-- ======== END OF BOTTOM NAVBAR ======= -->
297
298<HR>
299
300</BODY>
301</HTML>
Note: See TracBrowser for help on using the repository browser.