public class BoundedInputStream extends InputStream
This is useful to wrap ServletInputStreams. The ServletInputStream will block if you try to read content from it that isn't there, because it doesn't know whether the content hasn't arrived yet or whether the content has finished. So, one of these, initialized with the Content-length sent in the ServletInputStream's header, will stop it blocking, providing it's been sent with a correct content length.
Constructor and Description |
---|
BoundedInputStream(InputStream in)
Creates a new
BoundedInputStream that wraps the given input
stream and is unlimited. |
BoundedInputStream(InputStream in,
long size)
Creates a new
BoundedInputStream that wraps the given input
stream and limits it to a certain size. |
Modifier and Type | Method and Description |
---|---|
int |
available() |
void |
close()
|
boolean |
isPropagateClose()
Indicates whether the
close() method
should propagate to the underling InputStream . |
void |
mark(int readlimit)
Invokes the delegate's
mark(int) method. |
boolean |
markSupported()
Invokes the delegate's
markSupported() method. |
int |
read()
Invokes the delegate's
read() method if
the current position is less than the limit. |
int |
read(byte[] b)
Invokes the delegate's
read(byte[]) method. |
int |
read(byte[] b,
int off,
int len)
Invokes the delegate's
read(byte[], int, int) method. |
void |
reset()
Invokes the delegate's
reset() method. |
void |
setPropagateClose(boolean propagateClose)
Set whether the
close() method
should propagate to the underling InputStream . |
long |
skip(long n)
Invokes the delegate's
skip(long) method. |
String |
toString()
Invokes the delegate's
toString() method. |
public BoundedInputStream(InputStream in, long size)
BoundedInputStream
that wraps the given input
stream and limits it to a certain size.in
- The wrapped input streamsize
- The maximum number of bytes to returnpublic BoundedInputStream(InputStream in)
BoundedInputStream
that wraps the given input
stream and is unlimited.in
- The wrapped input streampublic int read() throws IOException
read()
method if
the current position is less than the limit.read
in class InputStream
IOException
- if an I/O error occurspublic int read(byte[] b) throws IOException
read(byte[])
method.read
in class InputStream
b
- the buffer to read the bytes intoIOException
- if an I/O error occurspublic int read(byte[] b, int off, int len) throws IOException
read(byte[], int, int)
method.read
in class InputStream
b
- the buffer to read the bytes intooff
- The start offsetlen
- The number of bytes to readIOException
- if an I/O error occurspublic long skip(long n) throws IOException
skip(long)
method.skip
in class InputStream
n
- the number of bytes to skipIOException
- if an I/O error occurspublic int available() throws IOException
available
in class InputStream
IOException
public void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
close
in class InputStream
IOException
- if an I/O error occurspublic void reset() throws IOException
reset()
method.reset
in class InputStream
IOException
- if an I/O error occurspublic void mark(int readlimit)
mark(int)
method.mark
in class InputStream
readlimit
- read ahead limitpublic boolean markSupported()
markSupported()
method.markSupported
in class InputStream
public boolean isPropagateClose()
close()
method
should propagate to the underling InputStream
.true
if calling close()
propagates to the close()
method of the
underlying stream or false
if it does not.public void setPropagateClose(boolean propagateClose)
close()
method
should propagate to the underling InputStream
.propagateClose
- true
if calling
close()
propagates to the close()
method of the underlying stream or
false
if it does not.Copyright © 2002–2020 The Apache Software Foundation. All rights reserved.