|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.InputStream
com.microsoft.tfs.core.httpclient.ContentLengthInputStream
public class ContentLengthInputStream
Cuts the wrapped InputStream off after a specified number of bytes.
Implementation note: Choices abound. One approach would pass through the
InputStream.mark(int)
and InputStream.reset()
calls to the
underlying stream. That's tricky, though, because you then have to start
duplicating the work of keeping track of how much a reset rewinds. Further,
you have to watch out for the "readLimit", and since the semantics for the
readLimit leave room for differing implementations, you might get into a lot
of trouble.
Alternatively, you could make this class extend
BufferedInputStream
and then use the protected members of
that class to avoid duplicated effort. That solution has the side effect of
adding yet another possible layer of buffering.
Then, there is the simple choice, which this takes - simply don't support
InputStream.mark(int)
and InputStream.reset()
. That choice has the
added benefit of keeping this class very simple.
Constructor Summary | |
---|---|
ContentLengthInputStream(java.io.InputStream in,
int contentLength)
Deprecated. use ContentLengthInputStream(InputStream, long)
Creates a new length limited stream |
|
ContentLengthInputStream(java.io.InputStream in,
long contentLength)
Creates a new length limited stream |
Method Summary | |
---|---|
int |
available()
|
void |
close()
Reads until the end of the known length of content. |
int |
read()
Read the next byte from the stream |
int |
read(byte[] b)
Read more bytes from the stream. |
int |
read(byte[] b,
int off,
int len)
Does standard InputStream.read(byte[], int, int) behavior, but
also notifies the watcher when the contents have been consumed. |
long |
skip(long n)
Skips and discards a number of bytes from the input stream. |
Methods inherited from class java.io.InputStream |
---|
mark, markSupported, reset |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
@Deprecated public ContentLengthInputStream(java.io.InputStream in, int contentLength)
ContentLengthInputStream(InputStream, long)
Creates a new length limited stream
in
- The stream to wrapcontentLength
- The maximum number of bytes that can be read from the stream.
Subsequent read operations will return -1.public ContentLengthInputStream(java.io.InputStream in, long contentLength)
in
- The stream to wrapcontentLength
- The maximum number of bytes that can be read from the stream.
Subsequent read operations will return -1.Method Detail |
---|
public void close() throws java.io.IOException
Reads until the end of the known length of content.
Does not close the underlying socket input, but instead leaves it primed to parse the next response.
close
in interface java.io.Closeable
close
in class java.io.InputStream
java.io.IOException
- If an IO problem occurs.public int read() throws java.io.IOException
read
in class java.io.InputStream
InputStream.read()
java.io.IOException
- If an IO problem occurspublic int read(byte[] b, int off, int len) throws java.io.IOException
InputStream.read(byte[], int, int)
behavior, but
also notifies the watcher when the contents have been consumed.
read
in class java.io.InputStream
b
- The byte array to fill.off
- Start filling at this position.len
- The number of bytes to attempt to read.
java.io.IOException
- Should an error occur on the wrapped stream.public int read(byte[] b) throws java.io.IOException
read
in class java.io.InputStream
b
- The byte array to put the new data in.
InputStream.read(byte[])
java.io.IOException
- If an IO problem occurspublic long skip(long n) throws java.io.IOException
skip
in class java.io.InputStream
n
- The number of bytes to skip.
InputStream.skip(long)
java.io.IOException
- If an error occurs while skipping bytes.public int available() throws java.io.IOException
available
in class java.io.InputStream
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |