PageRenderTime 28ms CodeModel.GetById 11ms app.highlight 12ms RepoModel.GetById 1ms app.codeStats 0ms

/lib/bouncycastle/docs/org/bouncycastle/util/io/Streams.html

https://bitbucket.org/arkban/somersault
HTML | 401 lines | 329 code | 50 blank | 22 comment | 0 complexity | e3cf55868c847fa4c656b65662cfdca4 MD5 | raw file
Possible License(s): LGPL-2.1, BSD-3-Clause, Apache-2.0
  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) on Mon Jan 11 13:46:41 EST 2010 -->
  6<TITLE>
  7Streams (Bouncy Castle Library 1.45 API Specification)
  8</TITLE>
  9
 10<META NAME="date" CONTENT="2010-01-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="Streams (Bouncy Castle Library 1.45 API Specification)";
 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<b>Bouncy Castle Cryptography Library 1.45</b></EM>
 52</TD>
 53</TR>
 54
 55<TR>
 56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 57&nbsp;<A HREF="../../../../org/bouncycastle/util/io/StreamOverflowException.html" title="class in org.bouncycastle.util.io"><B>PREV CLASS</B></A>&nbsp;
 58&nbsp;NEXT CLASS</FONT></TD>
 59<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 60  <A HREF="../../../../index.html?org/bouncycastle/util/io/Streams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 61&nbsp;<A HREF="Streams.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;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 80DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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">
 90org.bouncycastle.util.io</FONT>
 91<BR>
 92Class Streams</H2>
 93<PRE>
 94java.lang.Object
 95  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.bouncycastle.util.io.Streams</B>
 96</PRE>
 97<HR>
 98<DL>
 99<DT><PRE>public final class <B>Streams</B><DT>extends java.lang.Object</DL>
100</PRE>
101
102<P>
103<HR>
104
105<P>
106
107<!-- ======== CONSTRUCTOR SUMMARY ======== -->
108
109<A NAME="constructor_summary"><!-- --></A>
110<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
111<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
112<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
113<B>Constructor Summary</B></FONT></TH>
114</TR>
115<TR BGCOLOR="white" CLASS="TableRowColor">
116<TD><CODE><B><A HREF="../../../../org/bouncycastle/util/io/Streams.html#Streams()">Streams</A></B>()</CODE>
117
118<BR>
119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
120</TR>
121</TABLE>
122&nbsp;
123<!-- ========== METHOD SUMMARY =========== -->
124
125<A NAME="method_summary"><!-- --></A>
126<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
128<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
129<B>Method Summary</B></FONT></TH>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133<CODE>static&nbsp;void</CODE></FONT></TD>
134<TD><CODE><B><A HREF="../../../../org/bouncycastle/util/io/Streams.html#drain(java.io.InputStream)">drain</A></B>(java.io.InputStream&nbsp;inStr)</CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>static&nbsp;void</CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../../org/bouncycastle/util/io/Streams.html#pipeAll(java.io.InputStream, java.io.OutputStream)">pipeAll</A></B>(java.io.InputStream&nbsp;inStr,
143        java.io.OutputStream&nbsp;outStr)</CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<CODE>static&nbsp;long</CODE></FONT></TD>
151<TD><CODE><B><A HREF="../../../../org/bouncycastle/util/io/Streams.html#pipeAllLimited(java.io.InputStream, long, java.io.OutputStream)">pipeAllLimited</A></B>(java.io.InputStream&nbsp;inStr,
152               long&nbsp;limit,
153               java.io.OutputStream&nbsp;outStr)</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>static&nbsp;byte[]</CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../../org/bouncycastle/util/io/Streams.html#readAll(java.io.InputStream)">readAll</A></B>(java.io.InputStream&nbsp;inStr)</CODE>
162
163<BR>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>static&nbsp;byte[]</CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../../org/bouncycastle/util/io/Streams.html#readAllLimited(java.io.InputStream, int)">readAllLimited</A></B>(java.io.InputStream&nbsp;inStr,
170               int&nbsp;limit)</CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177<CODE>static&nbsp;int</CODE></FONT></TD>
178<TD><CODE><B><A HREF="../../../../org/bouncycastle/util/io/Streams.html#readFully(java.io.InputStream, byte[])">readFully</A></B>(java.io.InputStream&nbsp;inStr,
179          byte[]&nbsp;buf)</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>static&nbsp;int</CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../org/bouncycastle/util/io/Streams.html#readFully(java.io.InputStream, byte[], int, int)">readFully</A></B>(java.io.InputStream&nbsp;inStr,
188          byte[]&nbsp;buf,
189          int&nbsp;off,
190          int&nbsp;len)</CODE>
191
192<BR>
193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
194</TR>
195</TABLE>
196&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
199<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
200</TR>
201<TR BGCOLOR="white" CLASS="TableRowColor">
202<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
203</TR>
204</TABLE>
205&nbsp;
206<P>
207
208<!-- ========= CONSTRUCTOR DETAIL ======== -->
209
210<A NAME="constructor_detail"><!-- --></A>
211<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
212<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
213<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
214<B>Constructor Detail</B></FONT></TH>
215</TR>
216</TABLE>
217
218<A NAME="Streams()"><!-- --></A><H3>
219Streams</H3>
220<PRE>
221public <B>Streams</B>()</PRE>
222<DL>
223</DL>
224
225<!-- ============ METHOD DETAIL ========== -->
226
227<A NAME="method_detail"><!-- --></A>
228<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
229<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
230<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
231<B>Method Detail</B></FONT></TH>
232</TR>
233</TABLE>
234
235<A NAME="drain(java.io.InputStream)"><!-- --></A><H3>
236drain</H3>
237<PRE>
238public static void <B>drain</B>(java.io.InputStream&nbsp;inStr)
239                  throws java.io.IOException</PRE>
240<DL>
241<DD><DL>
242
243<DT><B>Throws:</B>
244<DD><CODE>java.io.IOException</CODE></DL>
245</DD>
246</DL>
247<HR>
248
249<A NAME="readAll(java.io.InputStream)"><!-- --></A><H3>
250readAll</H3>
251<PRE>
252public static byte[] <B>readAll</B>(java.io.InputStream&nbsp;inStr)
253                      throws java.io.IOException</PRE>
254<DL>
255<DD><DL>
256
257<DT><B>Throws:</B>
258<DD><CODE>java.io.IOException</CODE></DL>
259</DD>
260</DL>
261<HR>
262
263<A NAME="readAllLimited(java.io.InputStream, int)"><!-- --></A><H3>
264readAllLimited</H3>
265<PRE>
266public static byte[] <B>readAllLimited</B>(java.io.InputStream&nbsp;inStr,
267                                    int&nbsp;limit)
268                             throws java.io.IOException</PRE>
269<DL>
270<DD><DL>
271
272<DT><B>Throws:</B>
273<DD><CODE>java.io.IOException</CODE></DL>
274</DD>
275</DL>
276<HR>
277
278<A NAME="readFully(java.io.InputStream, byte[])"><!-- --></A><H3>
279readFully</H3>
280<PRE>
281public static int <B>readFully</B>(java.io.InputStream&nbsp;inStr,
282                            byte[]&nbsp;buf)
283                     throws java.io.IOException</PRE>
284<DL>
285<DD><DL>
286
287<DT><B>Throws:</B>
288<DD><CODE>java.io.IOException</CODE></DL>
289</DD>
290</DL>
291<HR>
292
293<A NAME="readFully(java.io.InputStream, byte[], int, int)"><!-- --></A><H3>
294readFully</H3>
295<PRE>
296public static int <B>readFully</B>(java.io.InputStream&nbsp;inStr,
297                            byte[]&nbsp;buf,
298                            int&nbsp;off,
299                            int&nbsp;len)
300                     throws java.io.IOException</PRE>
301<DL>
302<DD><DL>
303
304<DT><B>Throws:</B>
305<DD><CODE>java.io.IOException</CODE></DL>
306</DD>
307</DL>
308<HR>
309
310<A NAME="pipeAll(java.io.InputStream, java.io.OutputStream)"><!-- --></A><H3>
311pipeAll</H3>
312<PRE>
313public static void <B>pipeAll</B>(java.io.InputStream&nbsp;inStr,
314                           java.io.OutputStream&nbsp;outStr)
315                    throws java.io.IOException</PRE>
316<DL>
317<DD><DL>
318
319<DT><B>Throws:</B>
320<DD><CODE>java.io.IOException</CODE></DL>
321</DD>
322</DL>
323<HR>
324
325<A NAME="pipeAllLimited(java.io.InputStream, long, java.io.OutputStream)"><!-- --></A><H3>
326pipeAllLimited</H3>
327<PRE>
328public static long <B>pipeAllLimited</B>(java.io.InputStream&nbsp;inStr,
329                                  long&nbsp;limit,
330                                  java.io.OutputStream&nbsp;outStr)
331                           throws java.io.IOException</PRE>
332<DL>
333<DD><DL>
334
335<DT><B>Throws:</B>
336<DD><CODE>java.io.IOException</CODE></DL>
337</DD>
338</DL>
339<!-- ========= END OF CLASS DATA ========= -->
340<HR>
341
342
343<!-- ======= START OF BOTTOM NAVBAR ====== -->
344<A NAME="navbar_bottom"><!-- --></A>
345<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
346<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
347<TR>
348<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
349<A NAME="navbar_bottom_firstrow"><!-- --></A>
350<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
351  <TR ALIGN="center" VALIGN="top">
352  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
353  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
354  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
355  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
356  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
357  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
358  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
359  </TR>
360</TABLE>
361</TD>
362<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
363<b>Bouncy Castle Cryptography Library 1.45</b></EM>
364</TD>
365</TR>
366
367<TR>
368<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
369&nbsp;<A HREF="../../../../org/bouncycastle/util/io/StreamOverflowException.html" title="class in org.bouncycastle.util.io"><B>PREV CLASS</B></A>&nbsp;
370&nbsp;NEXT CLASS</FONT></TD>
371<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
372  <A HREF="../../../../index.html?org/bouncycastle/util/io/Streams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
373&nbsp;<A HREF="Streams.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
374&nbsp;<SCRIPT type="text/javascript">
375  <!--
376  if(window==top) {
377    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
378  }
379  //-->
380</SCRIPT>
381<NOSCRIPT>
382  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
383</NOSCRIPT>
384
385
386</FONT></TD>
387</TR>
388<TR>
389<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
390  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
391<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
392DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
393</TR>
394</TABLE>
395<A NAME="skip-navbar_bottom"></A>
396<!-- ======== END OF BOTTOM NAVBAR ======= -->
397
398<HR>
399
400</BODY>
401</HTML>