Class BoundedInputStream
- java.lang.Object
-
- java.io.InputStream
-
- java.io.FilterInputStream
-
- org.apache.commons.io.input.ProxyInputStream
-
- org.apache.commons.io.input.BoundedInputStream
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public class BoundedInputStream extends ProxyInputStream
Reads bytes up to a maximum count and stops once reached.To build an instance, see
BoundedInputStream.AbstractBuilder
.By default, a
BoundedInputStream
is unbound; so make sure to callBoundedInputStream.AbstractBuilder.setMaxCount(long)
.You can find out how many bytes this stream has seen so far by calling
getCount()
. This value reflects bytes read and skipped.Using a ServletInputStream
A
ServletInputStream
can block if you try to read content that isn't there because it doesn't know whether the content hasn't arrived yet or whether the content has finished. Initialize anBoundedInputStream
with theContent-Length
sent in theServletInputStream
's header, this stop it from blocking, providing it's been sent with a correct content length in the first place.Using NIO
BoundedInputStream s = BoundedInputStream.builder() .setPath(Paths.get("MyFile.xml")) .setMaxCount(1024) .setPropagateClose(false) .get();
Using IO
BoundedInputStream s = BoundedInputStream.builder() .setFile(new File("MyFile.xml")) .setMaxCount(1024) .setPropagateClose(false) .get();
Counting Bytes
You can set the running count when building, which is most useful when starting from another stream:
InputStream in = ...; BoundedInputStream s = BoundedInputStream.builder() .setInputStream(in) .setCount(12) .setMaxCount(1024) .setPropagateClose(false) .get();
Listening for the max count reached
BoundedInputStream s = BoundedInputStream.builder() .setPath(Paths.get("MyFile.xml")) .setMaxCount(1024) .setOnMaxCount((max, count) -> System.out.printf("Max count %,d reached with a last read count of %,d%n", max, count)) .get();
- Since:
- 2.0
- See Also:
BoundedInputStream.Builder
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BoundedInputStream.Builder
Builds a newBoundedInputStream
.
-
Constructor Summary
Constructors Constructor Description BoundedInputStream(java.io.InputStream in)
Deprecated.UseIOSupplier.get()
.BoundedInputStream(java.io.InputStream inputStream, long maxCount)
Deprecated.UseIOSupplier.get()
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
afterRead(int n)
Adds the number of read bytes to the count.int
available()
Invokes the delegate'sInputStream.available()
method.static BoundedInputStream.Builder
builder()
Constructs a newBoundedInputStream.AbstractBuilder
.void
close()
long
getCount()
Gets the count of bytes read.long
getMaxCount()
Gets the max count of bytes to read.long
getMaxLength()
Deprecated.UsegetMaxCount()
.long
getRemaining()
Gets how many bytes remain to read.boolean
isPropagateClose()
Tests whether theclose()
method should propagate to the underlingInputStream
.void
mark(int readLimit)
Invokes the delegate'sInputStream.mark(int)
method.boolean
markSupported()
Invokes the delegate'sInputStream.markSupported()
method.protected void
onMaxLength(long max, long count)
A caller has caused a request that would cross themaxLength
boundary.int
read()
Invokes the delegate'sInputStream.read()
method if the current position is less than the limit.int
read(byte[] b)
Invokes the delegate'sInputStream.read(byte[])
method.int
read(byte[] b, int off, int len)
Invokes the delegate'sInputStream.read(byte[], int, int)
method.void
reset()
Invokes the delegate'sInputStream.reset()
method.void
setPropagateClose(boolean propagateClose)
Deprecated.UseBoundedInputStream.AbstractBuilder.setPropagateClose(boolean)
.long
skip(long n)
Invokes the delegate'sInputStream.skip(long)
method.java.lang.String
toString()
Invokes the delegate'sObject.toString()
method.-
Methods inherited from class org.apache.commons.io.input.ProxyInputStream
beforeRead, handleIOException, unwrap
-
-
-
-
Constructor Detail
-
BoundedInputStream
@Deprecated public BoundedInputStream(java.io.InputStream in)
Deprecated.UseIOSupplier.get()
.Constructs a newBoundedInputStream
that wraps the given input stream and is unlimited.- Parameters:
in
- The wrapped input stream.
-
BoundedInputStream
@Deprecated public BoundedInputStream(java.io.InputStream inputStream, long maxCount)
Deprecated.UseIOSupplier.get()
.Constructs a newBoundedInputStream
that wraps the given input stream and limits it to a certain size.- Parameters:
inputStream
- The wrapped input stream.maxCount
- The maximum number of bytes to return.
-
-
Method Detail
-
builder
public static BoundedInputStream.Builder builder()
Constructs a newBoundedInputStream.AbstractBuilder
.- Returns:
- a new
BoundedInputStream.AbstractBuilder
. - Since:
- 2.16.0
-
afterRead
protected void afterRead(int n) throws java.io.IOException
Adds the number of read bytes to the count.- Overrides:
afterRead
in classProxyInputStream
- Parameters:
n
- number of bytes read, or -1 if no more bytes are available- Throws:
java.io.IOException
- Not thrown here but subclasses may throw.- Since:
- 2.0
-
available
public int available() throws java.io.IOException
Invokes the delegate'sInputStream.available()
method.- Overrides:
available
in classProxyInputStream
- Returns:
- the number of available bytes, 0 if the stream is closed.
- Throws:
java.io.IOException
- if an I/O error occurs.
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classProxyInputStream
- Throws:
java.io.IOException
- if an I/O error occurs.
-
getCount
public long getCount()
Gets the count of bytes read.- Returns:
- The count of bytes read.
- Since:
- 2.12.0
-
getMaxCount
public long getMaxCount()
Gets the max count of bytes to read.- Returns:
- The max count of bytes to read.
- Since:
- 2.16.0
-
getMaxLength
@Deprecated public long getMaxLength()
Deprecated.UsegetMaxCount()
.Gets the max count of bytes to read.- Returns:
- The max count of bytes to read.
- Since:
- 2.12.0
-
getRemaining
public long getRemaining()
Gets how many bytes remain to read.- Returns:
- bytes how many bytes remain to read.
- Since:
- 2.16.0
-
isPropagateClose
public boolean isPropagateClose()
Tests whether theclose()
method should propagate to the underlingInputStream
.- Returns:
true
if callingclose()
propagates to theclose()
method of the underlying stream orfalse
if it does not.
-
mark
public void mark(int readLimit)
Invokes the delegate'sInputStream.mark(int)
method.- Overrides:
mark
in classProxyInputStream
- Parameters:
readLimit
- read ahead limit
-
markSupported
public boolean markSupported()
Invokes the delegate'sInputStream.markSupported()
method.- Overrides:
markSupported
in classProxyInputStream
- Returns:
- true if mark is supported, otherwise false
- See Also:
ProxyInputStream.mark(int)
,ProxyInputStream.reset()
-
onMaxLength
protected void onMaxLength(long max, long count) throws java.io.IOException
A caller has caused a request that would cross themaxLength
boundary.Delegates to the consumer set in
BoundedInputStream.AbstractBuilder.setOnMaxCount(IOBiConsumer)
.- Parameters:
max
- The max count of bytes to read.count
- The count of bytes read.- Throws:
java.io.IOException
- Subclasses may throw.- Since:
- 2.12.0
-
read
public int read() throws java.io.IOException
Invokes the delegate'sInputStream.read()
method if the current position is less than the limit.- Overrides:
read
in classProxyInputStream
- Returns:
- the byte read or -1 if the end of stream or the limit has been reached.
- Throws:
java.io.IOException
- if an I/O error occurs.
-
read
public int read(byte[] b) throws java.io.IOException
Invokes the delegate'sInputStream.read(byte[])
method.- Overrides:
read
in classProxyInputStream
- Parameters:
b
- the buffer to read the bytes into- Returns:
- the number of bytes read or -1 if the end of stream or the limit has been reached.
- Throws:
java.io.IOException
- if an I/O error occurs.
-
read
public int read(byte[] b, int off, int len) throws java.io.IOException
Invokes the delegate'sInputStream.read(byte[], int, int)
method.- Overrides:
read
in classProxyInputStream
- Parameters:
b
- the buffer to read the bytes intooff
- The start offsetlen
- The number of bytes to read- Returns:
- the number of bytes read or -1 if the end of stream or the limit has been reached.
- Throws:
java.io.IOException
- if an I/O error occurs.
-
reset
public void reset() throws java.io.IOException
Invokes the delegate'sInputStream.reset()
method.- Overrides:
reset
in classProxyInputStream
- Throws:
java.io.IOException
- if an I/O error occurs.
-
setPropagateClose
@Deprecated public void setPropagateClose(boolean propagateClose)
Deprecated.UseBoundedInputStream.AbstractBuilder.setPropagateClose(boolean)
.Sets whether theclose()
method should propagate to the underlingInputStream
.- Parameters:
propagateClose
-true
if callingclose()
propagates to theclose()
method of the underlying stream orfalse
if it does not.
-
skip
public long skip(long n) throws java.io.IOException
Invokes the delegate'sInputStream.skip(long)
method.- Overrides:
skip
in classProxyInputStream
- Parameters:
n
- the number of bytes to skip- Returns:
- the actual number of bytes skipped
- Throws:
java.io.IOException
- if an I/O error occurs.
-
toString
public java.lang.String toString()
Invokes the delegate'sObject.toString()
method.- Overrides:
toString
in classjava.lang.Object
- Returns:
- the delegate's
Object.toString()
-
-