Package org.apache.commons.compress.compressors.xz

Class XZCompressorInputStream.Builder

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<T,B>

org.apache.commons.io.build.AbstractOriginSupplier<T,B>

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:

get(), LZMA2Options

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
XZCompressorInputStream	get()	Gets a result.
XZCompressorInputStream.Builder	setDecompressConcatenated(boolean decompressConcatenated)	Whether to decompress until the end of the input.
XZCompressorInputStream.Builder	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, setBufferSizeMax, setCharset, setCharset, setOpenOptions

Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier

setByteArray, setCharSequence, setFile, setFile, setInputStream, setOutputStream, setPath, setPath, setRandomAccessFile, setRandomAccessFile, setReader, setURI, setWriter

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.commons.io.function.IOSupplier

asSupplier, getUnchecked

Constructor Detail

Builder

public Builder()

Method Detail

get

public XZCompressorInputStream get()
                            throws java.io.IOException

Description copied from interface: IOSupplier

Gets a result.

Returns:

a result.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

IOSupplier.getUnchecked()

setDecompressConcatenated

public XZCompressorInputStream.Builder setDecompressConcatenated(boolean decompressConcatenated)

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

public XZCompressorInputStream.Builder setMemoryLimitKiB(int memoryLimitKiB)

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 on XZCompressorInputStream.read(), a MemoryLimitException is thrown.

Returns:

this instance.