sunlabs.brazil.util.http
public class HttpInputStream extends FilterInputStream
The underlying assumption of this class is that when reading the result
of an HTTP request, each byte in the input stream represents an 8-bit
ASCII character, and as such, it is perfectly valid to treat each byte
as a character. Locale-based conversion is not appropriate in this
circumstance, so the java.io.BufferedReader.readLine
method
should not be used.
Version: 2.2
Field Summary | |
---|---|
static int | defaultBufsize
The default size of the temporary buffer used when copying from an
input stream to an output stream.
|
Constructor Summary | |
---|---|
HttpInputStream(InputStream in)
Creates a new HttpInputStream that reads its input from the
specified input stream.
|
Method Summary | |
---|---|
int | copyTo(OutputStream out)
Copies bytes from this input stream to the specified output stream
until end of the input stream is reached.
|
int | copyTo(OutputStream out, int len)
Copies bytes from this input stream to the specified output stream
until the specified number of bytes are copied or the end of the
input stream is reached.
|
int | copyTo(OutputStream out, int len, byte[] buf)
Copies bytes from this input stream to the specified output stream
until the specified number of bytes are copied or the end of the
input stream is reached.
|
int | readFully(byte[] buf)
Reads buf.length bytes from the input stream. |
int | readFully(byte[] buf, int off, int len)
Reads the specified number of bytes from the input stream. |
String | readLine()
Reads the next line of text from the input stream.
|
String | readLine(int limit)
Reads the next line of text from the input stream, up to the
limit specified.
|
See Also: (OutputStream, int, byte[])
Parameters: in The underlying input stream.
Parameters: out The output stream to copy the data to.
Returns: The number of bytes copied to the output stream.
Throws: IOException if the underlying input stream throws an IOException while being read or if the output stream throws an IOException while being written. It may not be possible to distinguish amongst the two conditions.
Parameters: out The output stream to copy the data to. len The number of bytes to copy, or < 0 to copy until the end of this stream.
Returns: The number of bytes copied to the output stream.
Throws: IOException if the underlying input stream throws an IOException while being read or if the output stream throws an IOException while being written. It may not be possible to distinguish amongst the two conditions.
Parameters: out
The output stream to copy the data to.
len
The number of bytes to copy, or < 0 to copy until the end
of this stream.
buf
The buffer used to for holding the temporary results while
copying data from this input stream to the output stream.
May be null
to allow this method copy in
chunks of length defaultBufsize
.
Returns: The number of bytes read from the input stream, and copied to the output stream.
Throws: IOException if the underlying input stream throws an IOException while being read.
buf.length
bytes from the input stream. This
method reads repeatedly from the input stream until the specified
number of bytes have been read or the end of the input stream
is reached.
The standard InputStream.read
method will generally
return less than the specified number of bytes if the underlying
input stream is "bursty", such as from a network source. Sometimes
it is important to read the exact number of bytes desired.
Parameters: buf Buffer in which the data is stored. If buffer is of length 0, this method will return immediately.
Returns: The number of bytes read. This will be less than
buf.length
if the end of the input stream was
reached.
Throws: IOException if the underlying input stream throws an IOException while being read.
The standard InputStream.read
method will generally
return less than the specified number of bytes if the underlying
input stream is "bursty", such as from a network source. Sometimes
it is important to read the exact number of bytes desired.
Parameters: buf Buffer in which the data is stored. off The starting offset into the buffer. len The number of bytes to read.
Returns: The number of bytes read. This will be less than
len
if the end of the input stream was reached.
Throws: IOException if the underlying input stream throws an IOException while being read.
A line is terminated by "\r", "\n", "\r\n", or the end of the input stream. The line-terminating characters are discarded.
Returns: The next line from the input stream, or null
if the end of the input stream is reached and no bytes
were found.
Throws: IOException if the underlying input stream throws an IOException while being read.
A line is terminated by "\r", "\n", "\r\n", the end of the input
stream, or when the specified number of characters have been read.
The line-terminating characters are discarded. It is not possible
to distinguish, based on the result, between a line that was
exactly limit
characters long and a line that was
terminated because limit
characters were read.
Returns: The next line from the input stream, or null
if the end of the input stream is reached and no bytes
were found.
Throws: IOException if the underlying input stream throws an IOException while being read.