| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Fri Aug 22 03:43:58 EDT 2003 --> |
| <TITLE> |
| BufferedMultipartInputStream (Apache Struts API Documentation) |
| </TITLE> |
| <META NAME="keywords" CONTENT="org.apache.struts.upload.BufferedMultipartInputStream,BufferedMultipartInputStream class"> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <SCRIPT> |
| function asd() |
| { |
| parent.document.title="BufferedMultipartInputStream (Apache Struts API Documentation)"; |
| } |
| </SCRIPT> |
| <BODY BGCOLOR="white" onload="asd();"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BufferedMultipartInputStream.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="BufferedMultipartInputStream.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <SCRIPT> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
| </NOSCRIPT> |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.struts.upload</FONT> |
| <BR> |
| Class BufferedMultipartInputStream</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--java.io.InputStream |
| | |
| +--<B>org.apache.struts.upload.BufferedMultipartInputStream</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT>public class <B>BufferedMultipartInputStream</B><DT>extends java.io.InputStream</DL> |
| |
| <P> |
| This class implements buffering for an InputStream as well as a |
| readLine method. The purpose of this is to provide a reliable |
| readLine() method. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected byte[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#buffer">buffer</A></B></CODE> |
| |
| <BR> |
| The byte array used to hold buffered data</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#bufferLength">bufferLength</A></B></CODE> |
| |
| <BR> |
| The number of bytes read from the underlying InputStream that are |
| in the buffer</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#bufferOffset">bufferOffset</A></B></CODE> |
| |
| <BR> |
| The current offset we're at in the buffer's byte array</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#bufferSize">bufferSize</A></B></CODE> |
| |
| <BR> |
| The size of the byte array buffer</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#contentLength">contentLength</A></B></CODE> |
| |
| <BR> |
| The content length of the multipart data</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#contentLengthMet">contentLengthMet</A></B></CODE> |
| |
| <BR> |
| Whether or not bytes up to the Content-Length have been read</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.io.InputStream</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#inputStream">inputStream</A></B></CODE> |
| |
| <BR> |
| The underlying InputStream used by this class</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#maxLengthMet">maxLengthMet</A></B></CODE> |
| |
| <BR> |
| Whether or not bytes up to the maximum length have been read</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#maxSize">maxSize</A></B></CODE> |
| |
| <BR> |
| The maximum allowed size for the multipart data, or -1 for an unlimited |
| maximum file length</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#totalLength">totalLength</A></B></CODE> |
| |
| <BR> |
| The total number of bytes read so far</TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_java.io.InputStream"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Fields inherited from class java.io.InputStream</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#BufferedMultipartInputStream(java.io.InputStream, int, long, long)">BufferedMultipartInputStream</A></B>(java.io.InputStream inputStream, |
| int bufferSize, |
| long contentLength, |
| long maxSize)</CODE> |
| |
| <BR> |
| Public constructor for this class, just wraps the InputStream |
| given</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#available()">available</A></B>()</CODE> |
| |
| <BR> |
| This method returns the number of available bytes left to read |
| in the buffer before it has to be refilled</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#close()">close</A></B>()</CODE> |
| |
| <BR> |
| This method attempts to close the underlying InputStream</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#contentLengthMet()">contentLengthMet</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#fill()">fill</A></B>()</CODE> |
| |
| <BR> |
| Fills the buffer with data from the underlying inputStream.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#mark(int)">mark</A></B>(int position)</CODE> |
| |
| <BR> |
| This method calls on the mark() method of the underlying InputStream</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#markSupported()">markSupported</A></B>()</CODE> |
| |
| <BR> |
| This method calls on the markSupported() method of the underlying InputStream</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#maxLengthMet()">maxLengthMet</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#read()">read</A></B>()</CODE> |
| |
| <BR> |
| This method returns the next byte in the buffer, and refills it if necessary.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#read(byte[])">read</A></B>(byte[] b)</CODE> |
| |
| <BR> |
| This method populates the byte array <code>b</code> with data up to |
| <code>b.length</code> bytes</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#read(byte[], int, int)">read</A></B>(byte[] b, |
| int offset, |
| int length)</CODE> |
| |
| <BR> |
| This method populates the byte array <code>b</code> with data up to |
| <code>length</code> starting at b[offset]</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> byte[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#readLine()">readLine</A></B>()</CODE> |
| |
| <BR> |
| This method reads a line, regardless of length.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#readLine(byte[], int, int)">readLine</A></B>(byte[] b, |
| int offset, |
| int length)</CODE> |
| |
| <BR> |
| This method reads into the byte array <code>b</code> until |
| a newline ('\n') character is encountered or the number of bytes |
| specified by <code>length</code> have been read</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/BufferedMultipartInputStream.html#reset()">reset</A></B>()</CODE> |
| |
| <BR> |
| This method makes a call to the reset() method of the underlying |
| InputStream</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.io.InputStream"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.io.InputStream</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>skip</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="inputStream"><!-- --></A><H3> |
| inputStream</H3> |
| <PRE> |
| protected java.io.InputStream <B>inputStream</B></PRE> |
| <DL> |
| <DD>The underlying InputStream used by this class |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="buffer"><!-- --></A><H3> |
| buffer</H3> |
| <PRE> |
| protected byte[] <B>buffer</B></PRE> |
| <DL> |
| <DD>The byte array used to hold buffered data |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="bufferOffset"><!-- --></A><H3> |
| bufferOffset</H3> |
| <PRE> |
| protected int <B>bufferOffset</B></PRE> |
| <DL> |
| <DD>The current offset we're at in the buffer's byte array |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="bufferSize"><!-- --></A><H3> |
| bufferSize</H3> |
| <PRE> |
| protected int <B>bufferSize</B></PRE> |
| <DL> |
| <DD>The size of the byte array buffer |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="bufferLength"><!-- --></A><H3> |
| bufferLength</H3> |
| <PRE> |
| protected int <B>bufferLength</B></PRE> |
| <DL> |
| <DD>The number of bytes read from the underlying InputStream that are |
| in the buffer |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="totalLength"><!-- --></A><H3> |
| totalLength</H3> |
| <PRE> |
| protected int <B>totalLength</B></PRE> |
| <DL> |
| <DD>The total number of bytes read so far |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="contentLength"><!-- --></A><H3> |
| contentLength</H3> |
| <PRE> |
| protected long <B>contentLength</B></PRE> |
| <DL> |
| <DD>The content length of the multipart data |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="maxSize"><!-- --></A><H3> |
| maxSize</H3> |
| <PRE> |
| protected long <B>maxSize</B></PRE> |
| <DL> |
| <DD>The maximum allowed size for the multipart data, or -1 for an unlimited |
| maximum file length |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="contentLengthMet"><!-- --></A><H3> |
| contentLengthMet</H3> |
| <PRE> |
| protected boolean <B>contentLengthMet</B></PRE> |
| <DL> |
| <DD>Whether or not bytes up to the Content-Length have been read |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="maxLengthMet"><!-- --></A><H3> |
| maxLengthMet</H3> |
| <PRE> |
| protected boolean <B>maxLengthMet</B></PRE> |
| <DL> |
| <DD>Whether or not bytes up to the maximum length have been read |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="BufferedMultipartInputStream(java.io.InputStream, int, long, long)"><!-- --></A><H3> |
| BufferedMultipartInputStream</H3> |
| <PRE> |
| public <B>BufferedMultipartInputStream</B>(java.io.InputStream inputStream, |
| int bufferSize, |
| long contentLength, |
| long maxSize) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD>Public constructor for this class, just wraps the InputStream |
| given |
| <P> |
| <DT><B>Parameters:</B><DD><CODE>inputStream</CODE> - The underlying stream to read from<DD><CODE>bufferSize</CODE> - The size in bytes of the internal buffer<DD><CODE>contentLength</CODE> - The content length for this request<DD><CODE>maxSize</CODE> - The maximum size in bytes that this multipart |
| request can be, or -1 for an unlimited length</DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="available()"><!-- --></A><H3> |
| available</H3> |
| <PRE> |
| public int <B>available</B>()</PRE> |
| <DL> |
| <DD>This method returns the number of available bytes left to read |
| in the buffer before it has to be refilled |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>available</CODE> in class <CODE>java.io.InputStream</CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="close()"><!-- --></A><H3> |
| close</H3> |
| <PRE> |
| public void <B>close</B>() |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD>This method attempts to close the underlying InputStream |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>close</CODE> in class <CODE>java.io.InputStream</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DD><CODE>java.io.IOException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="mark(int)"><!-- --></A><H3> |
| mark</H3> |
| <PRE> |
| public void <B>mark</B>(int position)</PRE> |
| <DL> |
| <DD>This method calls on the mark() method of the underlying InputStream |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>mark</CODE> in class <CODE>java.io.InputStream</CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="markSupported()"><!-- --></A><H3> |
| markSupported</H3> |
| <PRE> |
| public boolean <B>markSupported</B>()</PRE> |
| <DL> |
| <DD>This method calls on the markSupported() method of the underlying InputStream |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>markSupported</CODE> in class <CODE>java.io.InputStream</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Whether or not the underlying InputStream supports marking</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="maxLengthMet()"><!-- --></A><H3> |
| maxLengthMet</H3> |
| <PRE> |
| public boolean <B>maxLengthMet</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true if the maximum length has been reached, false otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="contentLengthMet()"><!-- --></A><H3> |
| contentLengthMet</H3> |
| <PRE> |
| public boolean <B>contentLengthMet</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true if the content length has been reached, false otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="read()"><!-- --></A><H3> |
| read</H3> |
| <PRE> |
| public int <B>read</B>() |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD>This method returns the next byte in the buffer, and refills it if necessary. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE>read</CODE> in class <CODE>java.io.InputStream</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The next byte read in the buffer, or -1 if the end of the stream has |
| been reached |
| <DD><CODE>java.io.IOException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="read(byte[])"><!-- --></A><H3> |
| read</H3> |
| <PRE> |
| public int <B>read</B>(byte[] b) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD>This method populates the byte array <code>b</code> with data up to |
| <code>b.length</code> bytes |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>read</CODE> in class <CODE>java.io.InputStream</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DD><CODE>java.io.IOException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="read(byte[], int, int)"><!-- --></A><H3> |
| read</H3> |
| <PRE> |
| public int <B>read</B>(byte[] b, |
| int offset, |
| int length) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD>This method populates the byte array <code>b</code> with data up to |
| <code>length</code> starting at b[offset] |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>read</CODE> in class <CODE>java.io.InputStream</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DD><CODE>java.io.IOException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="readLine(byte[], int, int)"><!-- --></A><H3> |
| readLine</H3> |
| <PRE> |
| public int <B>readLine</B>(byte[] b, |
| int offset, |
| int length) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD>This method reads into the byte array <code>b</code> until |
| a newline ('\n') character is encountered or the number of bytes |
| specified by <code>length</code> have been read |
| <P> |
| <DD><DL> |
| |
| <DD><CODE>java.io.IOException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="readLine()"><!-- --></A><H3> |
| readLine</H3> |
| <PRE> |
| public byte[] <B>readLine</B>() |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD>This method reads a line, regardless of length. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>A byte array representing the line. |
| <DD><CODE>java.io.IOException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="reset()"><!-- --></A><H3> |
| reset</H3> |
| <PRE> |
| public void <B>reset</B>() |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD>This method makes a call to the reset() method of the underlying |
| InputStream |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>reset</CODE> in class <CODE>java.io.InputStream</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DD><CODE>java.io.IOException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fill()"><!-- --></A><H3> |
| fill</H3> |
| <PRE> |
| protected void <B>fill</B>() |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD>Fills the buffer with data from the underlying inputStream. If it can't |
| fill the entire buffer in one read, it will read as many times as necessary |
| to fill the buffer |
| <P> |
| <DD><DL> |
| |
| <DD><CODE>java.io.IOException</CODE></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BufferedMultipartInputStream.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="BufferedMultipartInputStream.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <SCRIPT> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
| </NOSCRIPT> |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2000-2003 - Apache Software Foundation |
| </BODY> |
| </HTML> |
