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

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:
org.apache.commons.io.function.IOSupplier<XZCompressorInputStream>
Enclosing class:
XZCompressorInputStream
public static class XZCompressorInputStream.Builder extends org.apache.commons.io.build.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:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private boolean
    decompressConcatenated
     
    private int
    memoryLimitKiB
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Builder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    XZCompressorInputStream
    get()
     
    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, 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

  • Field Details

    • memoryLimitKiB

      private int memoryLimitKiB

    • decompressConcatenated

      private boolean decompressConcatenated

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • get

      public XZCompressorInputStream get() throws IOException
      Throws:
      IOException

    • 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.