Package org.apache.commons.io.input
Class BoundedInputStream.AbstractBuilder<T extends BoundedInputStream.AbstractBuilder<T>>
java.lang.Object
org.apache.commons.io.build.AbstractSupplier<BoundedInputStream,T>
org.apache.commons.io.build.AbstractOriginSupplier<BoundedInputStream,T>
org.apache.commons.io.build.AbstractStreamBuilder<BoundedInputStream,T>
org.apache.commons.io.input.BoundedInputStream.AbstractBuilder<T>
- Type Parameters:
T
- The subclass.
- All Implemented Interfaces:
IOSupplier<BoundedInputStream>
- Direct Known Subclasses:
BoundedInputStream.Builder
- Enclosing class:
BoundedInputStream
abstract static class BoundedInputStream.AbstractBuilder<T extends BoundedInputStream.AbstractBuilder<T>>
extends AbstractStreamBuilder<BoundedInputStream,T>
For subclassing builders from
BoundedInputStream
subclassses.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate long
The current count of bytes counted.private long
The max count of bytes to read.private boolean
Flag ifBoundedInputStream.close()
should be propagated,true
by default. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) long
getCount()
(package private) long
(package private) boolean
setCount
(long count) Sets the current number of bytes counted.setMaxCount
(long maxCount) Sets the maximum number of bytes to return.setPropagateClose
(boolean propagateClose) Sets whether theBoundedInputStream.close()
method should propagate to the underlingInputStream
.Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getInputStream, getOpenOptions, getOutputStream, getPath, getReader, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptions
Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier
checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setReader, setURI, setWriter
Methods inherited from class org.apache.commons.io.build.AbstractSupplier
asThis
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.commons.io.function.IOSupplier
asSupplier, get
-
Field Details
-
count
private long countThe current count of bytes counted. -
maxCount
private long maxCountThe max count of bytes to read. -
propagateClose
private boolean propagateCloseFlag ifBoundedInputStream.close()
should be propagated,true
by default.
-
-
Constructor Details
-
AbstractBuilder
AbstractBuilder()
-
-
Method Details
-
getCount
long getCount() -
getMaxCount
long getMaxCount() -
isPropagateClose
boolean isPropagateClose() -
setCount
Sets the current number of bytes counted.Useful when building from another stream to carry forward a read count.
Default is
0
, negative means 0.- Parameters:
count
- The current number of bytes counted.- Returns:
- this.
-
setMaxCount
Sets the maximum number of bytes to return.Default is -1, negative means unbound.
- Parameters:
maxCount
- The maximum number of bytes to return.- Returns:
- this.
-
setPropagateClose
Sets whether theBoundedInputStream.close()
method should propagate to the underlingInputStream
.Default is
true
.- Parameters:
propagateClose
-true
if callingBoundedInputStream.close()
propagates to theclose()
method of the underlying stream orfalse
if it does not.- Returns:
- this.
-