PageRenderTime 45ms CodeModel.GetById 18ms app.highlight 20ms RepoModel.GetById 2ms app.codeStats 0ms

/lib/docs/org/apache/xmlrpc/util/LimitedInputStream.html

http://mp-rechnungs-und-kundenverwaltung.googlecode.com/
HTML | 409 lines | 342 code | 45 blank | 22 comment | 0 complexity | 2580a3a5ce3fb32a69c03112c4403de5 MD5 | raw file
  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_0) on Mon Apr 20 21:45:57 CEST 2009 -->
  6<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7<TITLE>
  8LimitedInputStream (Apache XML-RPC 3.1.2 API)
  9</TITLE>
 10
 11<META NAME="date" CONTENT="2009-04-20">
 12
 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
 14
 15<SCRIPT type="text/javascript">
 16function windowTitle()
 17{
 18    if (location.href.indexOf('is-external=true') == -1) {
 19        parent.document.title="LimitedInputStream (Apache XML-RPC 3.1.2 API)";
 20    }
 21}
 22</SCRIPT>
 23<NOSCRIPT>
 24</NOSCRIPT>
 25
 26</HEAD>
 27
 28<BODY BGCOLOR="white" onload="windowTitle();">
 29<HR>
 30
 31
 32<!-- ========= START OF TOP NAVBAR ======= -->
 33<A NAME="navbar_top"><!-- --></A>
 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 36<TR>
 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 38<A NAME="navbar_top_firstrow"><!-- --></A>
 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 40  <TR ALIGN="center" VALIGN="top">
 41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LimitedInputStream.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 48  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 49  </TR>
 50</TABLE>
 51</TD>
 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 53</EM>
 54</TD>
 55</TR>
 56
 57<TR>
 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 59&nbsp;<A HREF="../../../../org/apache/xmlrpc/util/HttpUtil.html" title="class in org.apache.xmlrpc.util"><B>PREV CLASS</B></A>&nbsp;
 60&nbsp;<A HREF="../../../../org/apache/xmlrpc/util/ReflectionUtil.html" title="class in org.apache.xmlrpc.util"><B>NEXT CLASS</B></A></FONT></TD>
 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 62  <A HREF="../../../../index.html?org/apache/xmlrpc/util/LimitedInputStream.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 63&nbsp;<A HREF="LimitedInputStream.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 64&nbsp;<SCRIPT type="text/javascript">
 65  <!--
 66  if(window==top) {
 67    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 68  }
 69  //-->
 70</SCRIPT>
 71<NOSCRIPT>
 72  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 73</NOSCRIPT>
 74
 75
 76</FONT></TD>
 77</TR>
 78<TR>
 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 80  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 82DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 83</TR>
 84</TABLE>
 85<A NAME="skip-navbar_top"></A>
 86<!-- ========= END OF TOP NAVBAR ========= -->
 87
 88<HR>
 89<!-- ======== START OF CLASS DATA ======== -->
 90<H2>
 91<FONT SIZE="-1">
 92org.apache.xmlrpc.util</FONT>
 93<BR>
 94Class LimitedInputStream</H2>
 95<PRE>
 96java.lang.Object
 97  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.io.InputStream
 98      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xmlrpc.util.LimitedInputStream</B>
 99</PRE>
100<DL>
101<DT><B>All Implemented Interfaces:</B> <DD>java.io.Closeable</DD>
102</DL>
103<HR>
104<DL>
105<DT><PRE>public class <B>LimitedInputStream</B><DT>extends java.io.InputStream</DL>
106</PRE>
107
108<P>
109A filtering <CODE>InputStream</CODE> for proper handling of
110 the <code>Content-Length</code> header: It guarantees to return
111 at most a given number of bytes.
112<P>
113
114<P>
115<HR>
116
117<P>
118
119<!-- ======== CONSTRUCTOR SUMMARY ======== -->
120
121<A NAME="constructor_summary"><!-- --></A>
122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125<B>Constructor Summary</B></FONT></TH>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/LimitedInputStream.html#LimitedInputStream(java.io.InputStream, int)">LimitedInputStream</A></B>(java.io.InputStream&nbsp;pIn,
129                   int&nbsp;pAvailable)</CODE>
130
131<BR>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new instance, reading from the given input stream
133 and returning at most the given number of bytes.</TD>
134</TR>
135</TABLE>
136&nbsp;
137<!-- ========== METHOD SUMMARY =========== -->
138
139<A NAME="method_summary"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
142<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
143<B>Method Summary</B></FONT></TH>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>&nbsp;void</CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/LimitedInputStream.html#mark(int)">mark</A></B>(int&nbsp;readlimit)</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155<CODE>&nbsp;boolean</CODE></FONT></TD>
156<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/LimitedInputStream.html#markSupported()">markSupported</A></B>()</CODE>
157
158<BR>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<CODE>&nbsp;int</CODE></FONT></TD>
164<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/LimitedInputStream.html#read()">read</A></B>()</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>&nbsp;int</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/LimitedInputStream.html#read(byte[], int, int)">read</A></B>(byte[]&nbsp;b,
173     int&nbsp;off,
174     int&nbsp;len)</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
178</TR>
179<TR BGCOLOR="white" CLASS="TableRowColor">
180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181<CODE>&nbsp;void</CODE></FONT></TD>
182<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/LimitedInputStream.html#reset()">reset</A></B>()</CODE>
183
184<BR>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
186</TR>
187<TR BGCOLOR="white" CLASS="TableRowColor">
188<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189<CODE>&nbsp;long</CODE></FONT></TD>
190<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/LimitedInputStream.html#skip(long)">skip</A></B>(long&nbsp;n)</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.io.InputStream"><!-- --></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.io.InputStream</B></TH>
200</TR>
201<TR BGCOLOR="white" CLASS="TableRowColor">
202<TD><CODE>available, close, read</CODE></TD>
203</TR>
204</TABLE>
205&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
206<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
207<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
208<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
212</TR>
213</TABLE>
214&nbsp;
215<P>
216
217<!-- ========= CONSTRUCTOR DETAIL ======== -->
218
219<A NAME="constructor_detail"><!-- --></A>
220<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
221<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
222<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
223<B>Constructor Detail</B></FONT></TH>
224</TR>
225</TABLE>
226
227<A NAME="LimitedInputStream(java.io.InputStream, int)"><!-- --></A><H3>
228LimitedInputStream</H3>
229<PRE>
230public <B>LimitedInputStream</B>(java.io.InputStream&nbsp;pIn,
231                          int&nbsp;pAvailable)</PRE>
232<DL>
233<DD>Creates a new instance, reading from the given input stream
234 and returning at most the given number of bytes.
235<P>
236<DL>
237<DT><B>Parameters:</B><DD><CODE>pIn</CODE> - Input stream being read.<DD><CODE>pAvailable</CODE> - Number of bytes available in <code>pIn</code>.</DL>
238</DL>
239
240<!-- ============ METHOD DETAIL ========== -->
241
242<A NAME="method_detail"><!-- --></A>
243<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
244<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
245<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
246<B>Method Detail</B></FONT></TH>
247</TR>
248</TABLE>
249
250<A NAME="read()"><!-- --></A><H3>
251read</H3>
252<PRE>
253public int <B>read</B>()
254         throws java.io.IOException</PRE>
255<DL>
256<DD><DL>
257<DT><B>Specified by:</B><DD><CODE>read</CODE> in class <CODE>java.io.InputStream</CODE></DL>
258</DD>
259<DD><DL>
260
261<DT><B>Throws:</B>
262<DD><CODE>java.io.IOException</CODE></DL>
263</DD>
264</DL>
265<HR>
266
267<A NAME="read(byte[], int, int)"><!-- --></A><H3>
268read</H3>
269<PRE>
270public int <B>read</B>(byte[]&nbsp;b,
271                int&nbsp;off,
272                int&nbsp;len)
273         throws java.io.IOException</PRE>
274<DL>
275<DD><DL>
276<DT><B>Overrides:</B><DD><CODE>read</CODE> in class <CODE>java.io.InputStream</CODE></DL>
277</DD>
278<DD><DL>
279
280<DT><B>Throws:</B>
281<DD><CODE>java.io.IOException</CODE></DL>
282</DD>
283</DL>
284<HR>
285
286<A NAME="skip(long)"><!-- --></A><H3>
287skip</H3>
288<PRE>
289public long <B>skip</B>(long&nbsp;n)
290          throws java.io.IOException</PRE>
291<DL>
292<DD><DL>
293<DT><B>Overrides:</B><DD><CODE>skip</CODE> in class <CODE>java.io.InputStream</CODE></DL>
294</DD>
295<DD><DL>
296
297<DT><B>Throws:</B>
298<DD><CODE>java.io.IOException</CODE></DL>
299</DD>
300</DL>
301<HR>
302
303<A NAME="mark(int)"><!-- --></A><H3>
304mark</H3>
305<PRE>
306public void <B>mark</B>(int&nbsp;readlimit)</PRE>
307<DL>
308<DD><DL>
309<DT><B>Overrides:</B><DD><CODE>mark</CODE> in class <CODE>java.io.InputStream</CODE></DL>
310</DD>
311<DD><DL>
312</DL>
313</DD>
314</DL>
315<HR>
316
317<A NAME="reset()"><!-- --></A><H3>
318reset</H3>
319<PRE>
320public void <B>reset</B>()
321           throws java.io.IOException</PRE>
322<DL>
323<DD><DL>
324<DT><B>Overrides:</B><DD><CODE>reset</CODE> in class <CODE>java.io.InputStream</CODE></DL>
325</DD>
326<DD><DL>
327
328<DT><B>Throws:</B>
329<DD><CODE>java.io.IOException</CODE></DL>
330</DD>
331</DL>
332<HR>
333
334<A NAME="markSupported()"><!-- --></A><H3>
335markSupported</H3>
336<PRE>
337public boolean <B>markSupported</B>()</PRE>
338<DL>
339<DD><DL>
340<DT><B>Overrides:</B><DD><CODE>markSupported</CODE> in class <CODE>java.io.InputStream</CODE></DL>
341</DD>
342<DD><DL>
343</DL>
344</DD>
345</DL>
346<!-- ========= END OF CLASS DATA ========= -->
347<HR>
348
349
350<!-- ======= START OF BOTTOM NAVBAR ====== -->
351<A NAME="navbar_bottom"><!-- --></A>
352<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
353<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
354<TR>
355<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
356<A NAME="navbar_bottom_firstrow"><!-- --></A>
357<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
358  <TR ALIGN="center" VALIGN="top">
359  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
360  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
361  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
362  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LimitedInputStream.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
363  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
364  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
365  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
366  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
367  </TR>
368</TABLE>
369</TD>
370<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
371</EM>
372</TD>
373</TR>
374
375<TR>
376<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
377&nbsp;<A HREF="../../../../org/apache/xmlrpc/util/HttpUtil.html" title="class in org.apache.xmlrpc.util"><B>PREV CLASS</B></A>&nbsp;
378&nbsp;<A HREF="../../../../org/apache/xmlrpc/util/ReflectionUtil.html" title="class in org.apache.xmlrpc.util"><B>NEXT CLASS</B></A></FONT></TD>
379<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
380  <A HREF="../../../../index.html?org/apache/xmlrpc/util/LimitedInputStream.html" target="_top"><B>FRAMES</B></A>  &nbsp;
381&nbsp;<A HREF="LimitedInputStream.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
382&nbsp;<SCRIPT type="text/javascript">
383  <!--
384  if(window==top) {
385    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
386  }
387  //-->
388</SCRIPT>
389<NOSCRIPT>
390  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
391</NOSCRIPT>
392
393
394</FONT></TD>
395</TR>
396<TR>
397<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
398  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
399<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
400DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
401</TR>
402</TABLE>
403<A NAME="skip-navbar_bottom"></A>
404<!-- ======== END OF BOTTOM NAVBAR ======= -->
405
406<HR>
407Copyright &#169; 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
408</BODY>
409</HTML>