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

Class XZCompressorOutputStream.Builder

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<XZCompressorOutputStream,XZCompressorOutputStream.Builder>

org.apache.commons.io.build.AbstractOriginSupplier<XZCompressorOutputStream,XZCompressorOutputStream.Builder>

org.apache.commons.io.build.AbstractStreamBuilder<XZCompressorOutputStream,XZCompressorOutputStream.Builder>

org.apache.commons.compress.compressors.xz.XZCompressorOutputStream.Builder

All Implemented Interfaces:

IOSupplier<XZCompressorOutputStream>

Enclosing class:

XZCompressorOutputStream

public static class XZCompressorOutputStream.Builder
extends AbstractStreamBuilder<XZCompressorOutputStream,XZCompressorOutputStream.Builder>

Builds a new XZCompressorOutputStream.

For example:

 XZCompressorOutputStream s = XZCompressorOutputStream.builder()
   .setPath(path)
   .setLzma2Options(new LZMA2Options(...))
   .get();
 
 

Since:

1.28.0

See Also:

• get()

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructs a new builder of XZCompressorOutputStream.

Method Summary

Modifier and Type	Method	Description
XZCompressorOutputStream	get()	Gets a result.
XZCompressorOutputStream.Builder	setLzma2Options(org.tukaani.xz.LZMA2Options lzma2Options)	Sets LZMA options.

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 Details

Builder

public Builder()

Constructs a new builder of XZCompressorOutputStream.

Method Details

get

public XZCompressorOutputStream get()
                             throws IOException

Description copied from interface: IOSupplier

Gets a result.

Returns:

a result.

Throws:

IOException - if an I/O error occurs.

See Also:

• IOSupplier.getUnchecked()

setLzma2Options

public XZCompressorOutputStream.Builder setLzma2Options(org.tukaani.xz.LZMA2Options lzma2Options)

Sets LZMA options.

Passing null resets to the default value LZMA2Options().

Parameters:

lzma2Options - LZMA options.

Returns:

this instance.