Class XZCompressorInputStream.Builder
java.lang.Object
org.apache.commons.io.build.AbstractSupplier<XZCompressorInputStream,XZCompressorInputStream.Builder>
org.apache.commons.io.build.AbstractOriginSupplier<XZCompressorInputStream,XZCompressorInputStream.Builder>
org.apache.commons.io.build.AbstractStreamBuilder<XZCompressorInputStream,XZCompressorInputStream.Builder>
org.apache.commons.compress.compressors.xz.XZCompressorInputStream.Builder
- All Implemented Interfaces:
IOSupplier<XZCompressorInputStream>
- Enclosing class:
XZCompressorInputStream
public static class XZCompressorInputStream.Builder
extends AbstractStreamBuilder<XZCompressorInputStream,XZCompressorInputStream.Builder>
Builds a new
LZMACompressorInputStream
.
For example:
XZCompressorInputStream s = XZCompressorInputStream.builder()
.setPath(path)
.setDecompressConcatenated(false)
.setMemoryLimitKiB(-1)
.get();
- Since:
- 1.28.0
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionget()
setDecompressConcatenated
(boolean decompressConcatenated) Whether to decompress until the end of the input.setMemoryLimitKiB
(int memoryLimitKiB) Sets a working memory threshold in kibibytes (KiB).Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getFile, getInputStream, getOpenOptions, getOutputStream, getPath, getRandomAccessFile, 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, newRandomAccessFileOrigin, newRandomAccessFileOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setRandomAccessFile, setRandomAccessFile, 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, getUnchecked
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
get
- Throws:
IOException
-
setDecompressConcatenated
Whether to decompress until the end of the input.- Parameters:
decompressConcatenated
- if true, decompress until the end of the input; if false, stop after the first .xz stream and leave the input position to point to the next byte after the .xz stream- Returns:
- this instance.
-
setMemoryLimitKiB
Sets a working memory threshold in kibibytes (KiB).- Parameters:
memoryLimitKiB
- The memory limit used when reading blocks. The memory usage limit is expressed in kibibytes (KiB) or-1
to impose no memory usage limit. If the estimated memory limit is exceeded onXZCompressorInputStream.read()
, aMemoryLimitException
is thrown.- Returns:
- this instance.
-