| java.lang.Object
 java.io.InputStream
com.lutris.mime.MultipartMimeInputStream
| MultipartMimeInputStream | | public class MultipartMimeInputStream extends InputStream (Code) | | Presents the current section of a multipart MIME stream as a distinct
InputStream object for which the end of the section is the end of the stream.
MIME headers for the current section are extracted, parsed, and made
available via the getMimeHeaders() method. The
stream itself begins at the first byte following the Mime header
section. Closing an instance of MultipartMimeInputStream
causes it to skip data on the underlying input stream until the next
section is found, or end-of-input is reached.
|
| Field Summary | |
| boolean | lastPart
Boolean that indicates that this input stream was the last part of the
total multipart input. |
| Method Summary | |
| public int | available()
Returns the number of bytes that can be read from this stream without
blocking. | | public void | close()
Skips all remaining bytes on this stream and closes it. | | public String[] | getGarbageHeaders()
Returns an array of all Mime header lines that could not be parsed in the
normal "name: value" fashion. | | public MimeHeader | getHeader(String headerName)
Returns a single MimeHeader object associated with a given
Mime header name. | | public MimeHeader[] | getHeaders(String headerName)
Returns a array of type MimeHeader containing all values
associated with a given Mime header name.
Parameters:
headerName - The name of the Mime header to return. | | public String[] | getRawHeaders()
Returns an array of String containing each Mime header as
it was read from the header of this section. | | public int | read()
Reads the next byte of data from this input stream. | | public int | read(byte[] buffer)
Reads up to buffer.length bytes of data from this input
stream into an array of bytes. | | public int | read(byte[] buffer, int offset, int length)
Reads length bytes of data from this input stream into an
array of bytes. | | public long | skip(long num)
Skips over and discards n bytes of data from this input
stream. |
| lastPart | | boolean lastPart(Code) | | Boolean that indicates that this input stream was the last part of the
total multipart input. This field is only to be accessed by the
MultipartMimeInput object.
|
| MultipartMimeInputStream | | protected MultipartMimeInputStream(BMByteSearchStream source, BMByteSearch sep) throws IOException, MimeEOFException(Code) | | Creates a MultipartFormStream object from the given pattern search stream
object, separator, and end of line pattern. This constructor may only be
called internally from within MultipartMimeInput or its
derived subclasses. Other packages never create instances of this class
directly.
Parameters:
source - Input stream that can perform a pattern serarch on the rawinput stream.
Parameters:
sep - Separator pattern.
exception:
IOException - If an I/O error occurs.
exception:
MimeEOFException - If at EOF and the current section does not exist. |
| MultipartMimeInputStream | | protected MultipartMimeInputStream(BMByteSearchStream source, BMByteSearch sep, String encoding) throws IOException, MimeEOFException(Code) | | Creates a MultipartFormStream object from the given pattern search stream
object, separator, and end of line pattern. This constructor may only be
called internally from within MultipartMimeInput or its
derived subclasses. Other packages never create instances of this class
directly.
Parameters:
source - Input stream that can perform a pattern serarch on the rawinput stream.
Parameters:
sep - Separator pattern.
Parameters:
encoding - String encoding to apply.
exception:
IOException - If an I/O error occurs.
exception:
MimeEOFException - If at EOF and the current section does not exist. |
| available | | public int available() throws IOException(Code) | | Returns the number of bytes that can be read from this stream without
blocking.
The number of bytes that can be read from this stream withoutblocking.
exception:
IOException - If an I/O error occurs. |
| close | | public void close() throws IOException(Code) | | Skips all remaining bytes on this stream and closes it. Further
operations on this stream, other than close() will cause
an IOException to be thrown.
exception:
IOException - If an I/O error occurs. |
| getGarbageHeaders | | public String[] getGarbageHeaders()(Code) | | Returns an array of all Mime header lines that could not be parsed in the
normal "name: value" fashion.
Array of raw Mime headers. |
| getHeader | | public MimeHeader getHeader(String headerName)(Code) | | Returns a single MimeHeader object associated with a given
Mime header name. If the selected header name is associated with more
than one value, then the last instance received from the input stream is
returned.
Parameters:
headerName - The name of the Mime header to return. The value of the header, or null if not found. |
| getHeaders | | public MimeHeader[] getHeaders(String headerName)(Code) | | Returns a array of type MimeHeader containing all values
associated with a given Mime header name.
Parameters:
headerName - The name of the Mime header to return. All values associated with the header, or null ifnot found. |
| getRawHeaders | | public String[] getRawHeaders()(Code) | | Returns an array of String containing each Mime header as
it was read from the header of this section. All whitespace and
punctuation is left intact.
Array of raw Mime headers. |
| read | | public int read() throws IOException(Code) | | Reads the next byte of data from this input stream. The value byte is
returned as an int in the range 0 to 255. If no byte is
available because the end of the stream has been reached, the value -1 is
returned. This method blocks until input data is available, the end of
the stream is detected, or an exception is thrown
The next byte of data, or -1 if the end of stream is reached.
exception:
IOException - If an I/O error occurs. |
| read | | public int read(byte[] buffer) throws IOException(Code) | | Reads up to buffer.length bytes of data from this input
stream into an array of bytes. This method blocks until some input is
available
Parameters:
buffer - The buffer into which data are read. The number of bytes actually read, or -1 if there are no morebytes because the end of stream has been reached.
exception:
IOException - If an I/O error occurs. |
| read | | public int read(byte[] buffer, int offset, int length) throws IOException(Code) | | Reads length bytes of data from this input stream into an
array of bytes. This method blocks until some input is available.
Parameters:
buffer - The buffer into which data are read.
Parameters:
offset - The start offset of the data.
Parameters:
length - The maximum number of bytes read. The total number of bytes read into the buffer, or -1 if thereare no more bytes because the end of stream has been reached.
exception:
IOException - If an I/O error occurs. |
| skip | | public long skip(long num) throws IOException(Code) | | Skips over and discards n bytes of data from this input
stream. The skip method may, for a variety of reasons, end
up skipping over some smaller number of bytes, possibly 0.
The actual number of bytes skipped is returned.
Parameters:
num - The number of bytes to be skipped. The actual number of bytes skipped.
exception:
IOException - If an I/O error occurs. |
|
|