Class BoundedInputStream
- All Implemented Interfaces:
Closeable,AutoCloseable
To build an instance: Use the builder() to access all features.
By default, a BoundedInputStream is unbound; so make sure to call BoundedInputStream.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 an BoundedInputStream with the
Content-Length sent in the ServletInputStream'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:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from class java.io.FilterInputStream
in -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.BoundedInputStream(InputStream inputStream, long maxCount) Deprecated.UseIOSupplier.get(). -
Method Summary
Modifier and TypeMethodDescriptionprotected voidafterRead(int n) Adds the number of read bytes to the count.intInvokes the delegate'sInputStream.available()method.static BoundedInputStream.Builderbuilder()Constructs a newBoundedInputStream.AbstractBuilder.voidclose()longgetCount()Gets the count of bytes read.longGets the max count of bytes to read.longDeprecated.UsegetMaxCount().longGets how many bytes remain to read.booleanTests whether theclose()method should propagate to the underlingInputStream.voidmark(int readLimit) Invokes the delegate'sInputStream.mark(int)method.booleanInvokes the delegate'sInputStream.markSupported()method.protected voidonMaxLength(long max, long count) A caller has caused a request that would cross themaxLengthboundary.intread()Invokes the delegate'sInputStream.read()method if the current position is less than the limit.intread(byte[] b) Invokes the delegate'sInputStream.read(byte[])method.intread(byte[] b, int off, int len) Invokes the delegate'sInputStream.read(byte[], int, int)method.voidreset()Invokes the delegate'sInputStream.reset()method.voidsetPropagateClose(boolean propagateClose) Deprecated.UseBoundedInputStream.AbstractBuilder.setPropagateClose(boolean).longskip(long n) Invokes the delegate'sInputStream.skip(long)method.toString()Invokes the delegate'sObject.toString()method.Methods inherited from class org.apache.commons.io.input.ProxyInputStream
beforeRead, handleIOException, setReference, unwrap
-
Constructor Details
-
BoundedInputStream
Deprecated.UseIOSupplier.get().Constructs a newBoundedInputStreamthat wraps the given input stream and is unbounded.To build an instance: Use the
builder()to access all features.- Parameters:
in- The wrapped input stream.
-
BoundedInputStream
Deprecated.UseIOSupplier.get().Constructs a newBoundedInputStreamthat 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, negative means unbound.
-
-
Method Details
-
builder
Constructs a newBoundedInputStream.AbstractBuilder.- Returns:
- a new
BoundedInputStream.AbstractBuilder. - Since:
- 2.16.0
-
afterRead
Adds the number of read bytes to the count.- Overrides:
afterReadin classProxyInputStream- Parameters:
n- number of bytes read, or -1 if no more bytes are available- Throws:
IOException- Not thrown here but subclasses may throw.- Since:
- 2.0
-
available
Invokes the delegate'sInputStream.available()method.- Overrides:
availablein classProxyInputStream- Returns:
- the number of available bytes, 0 if the stream is closed.
- Throws:
IOException- if an I/O error occurs.
-
close
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classProxyInputStream- Throws:
IOException- if an I/O error occurs.
-
getCount
Gets the count of bytes read.- Returns:
- The count of bytes read.
- Since:
- 2.12.0
-
getMaxCount
Gets the max count of bytes to read.- Returns:
- The max count of bytes to read.
- Since:
- 2.16.0
-
getMaxLength
Deprecated.UsegetMaxCount().Gets the max count of bytes to read.- Returns:
- The max count of bytes to read.
- Since:
- 2.12.0
-
getRemaining
Gets how many bytes remain to read.- Returns:
- bytes how many bytes remain to read.
- Since:
- 2.16.0
-
isPropagateClose
Tests whether theclose()method should propagate to the underlingInputStream.- Returns:
trueif callingclose()propagates to theclose()method of the underlying stream orfalseif it does not.
-
mark
Invokes the delegate'sInputStream.mark(int)method.- Overrides:
markin classProxyInputStream- Parameters:
readLimit- read ahead limit
-
markSupported
Invokes the delegate'sInputStream.markSupported()method.- Overrides:
markSupportedin classProxyInputStream- Returns:
- true if mark is supported, otherwise false
- See Also:
-
onMaxLength
A caller has caused a request that would cross themaxLengthboundary.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:
IOException- Subclasses may throw.- Since:
- 2.12.0
-
read
Invokes the delegate'sInputStream.read()method if the current position is less than the limit.- Overrides:
readin classProxyInputStream- Returns:
- the byte read or -1 if the end of stream or the limit has been reached.
- Throws:
IOException- if an I/O error occurs.
-
read
Invokes the delegate'sInputStream.read(byte[])method.- Overrides:
readin 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:
IOException- if an I/O error occurs.
-
read
Invokes the delegate'sInputStream.read(byte[], int, int)method.- Overrides:
readin 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:
IOException- if an I/O error occurs.
-
reset
Invokes the delegate'sInputStream.reset()method.- Overrides:
resetin classProxyInputStream- Throws:
IOException- if an I/O error occurs.
-
setPropagateClose
Deprecated.UseBoundedInputStream.AbstractBuilder.setPropagateClose(boolean).Sets whether theclose()method should propagate to the underlingInputStream.- Parameters:
propagateClose-trueif callingclose()propagates to theclose()method of the underlying stream orfalseif it does not.
-
skip
Invokes the delegate'sInputStream.skip(long)method.- Overrides:
skipin classProxyInputStream- Parameters:
n- the number of bytes to skip- Returns:
- the actual number of bytes skipped
- Throws:
IOException- if an I/O error occurs.
-
toString
Invokes the delegate'sObject.toString()method.- Overrides:
toStringin classObject- Returns:
- the delegate's
Object.toString()
-
IOSupplier.get().