Apache Commons Compress 1.26.0 · org.apache.commons.compress.compressors.CompressorStreamFactory

Field Summary

Modifier and Type	Field and Description
private static final Set<String>	ALL_NAMES
public static final String	BROTLI Constant (value br) used to identify the BROTLI compression algorithm.
public static final String	BZIP2 Constant (value bzip2) used to identify the BZIP2 compression algorithm.
private SortedMap<String, CompressorStreamProvider>	compressorInputStreamProviders
private SortedMap<String, CompressorStreamProvider>	compressorOutputStreamProviders
private volatile boolean	decompressConcatenated If true, decompress until the end of the input.
private final Boolean	decompressUntilEOF If true, decompress until the end of the input.
public static final String	DEFLATE Constant (value deflate) used to identify the Deflate compress method.
public static final String	DEFLATE64 Constant (value deflate64) used to identify the Deflate64 compress method.
public static final String	GZIP Constant (value gz) used to identify the GZIP compression algorithm.
public static final String	LZ4_BLOCK Constant (value lz4-block) used to identify the block LZ4 compression method.
public static final String	LZ4_FRAMED Constant (value lz4-framed) used to identify the frame LZ4 compression method.
public static final String	LZMA Constant (value lzma) used to identify the LZMA compression method.
private final int	memoryLimitInKb
public static final String	PACK200 Constant (value pack200) used to identify the PACK200 compression algorithm.
private static final CompressorStreamFactory	SINGLETON
public static final String	SNAPPY_FRAMED Constant (value snappy-framed) used to identify the "framed" Snappy compression method.
public static final String	SNAPPY_RAW Constant (value snappy-raw) used to identify the "raw" Snappy compression method.
public static final String	XZ Constant (value xz) used to identify the XZ compression method.
private static final String	YOU_NEED_BROTLI_DEC
private static final String	YOU_NEED_XZ_JAVA
private static final String	YOU_NEED_ZSTD_JNI
public static final String	Z Constant (value z) used to identify the traditional Unix compress method.
public static final String	ZSTANDARD Constant (value zstd) used to identify the Zstandard compression algorithm.

Constructor Summary

Access	Constructor and Description
public	CompressorStreamFactory() Constructs an instance with the decompress Concatenated option set to false.
public	CompressorStreamFactory(final boolean if true, decompress until the end of the input; if false, stop after the first stream and leave the input position to point to the next byte after the stream. This setting applies to the gzip, bzip2 and XZ formats only. decompressUntilEOF) Constructs an instance with the provided decompress Concatenated option.
public	CompressorStreamFactory(final boolean if true, decompress until the end of the input; if false, stop after the first stream and leave the input position to point to the next byte after the stream. This setting applies to the gzip, bzip2 and XZ formats only. decompressUntilEOF, final int Some streams require allocation of potentially significant byte arrays/tables, and they can offer checks to prevent OOMs on corrupt files. Set the maximum allowed memory allocation in KBs. memoryLimitInKb) Constructs an instance with the provided decompress Concatenated option.

Method Summary

Modifier and Type	Method and Description
private static Iterable<CompressorStreamProvider>	archiveStreamProviderIterable()
public CompressorInputStream	Returns: the compressor input stream createCompressorInputStream(final InputStream the input stream in) Creates a compressor input stream from an input stream, auto-detecting the compressor type from the first few bytes of the stream.
public CompressorInputStream	Returns: the compressor input stream createCompressorInputStream(final InputStream the input stream in, final Set<String> compressor names to limit autodetection compressorNames) Creates a compressor input stream from an input stream, auto-detecting the compressor type from the first few bytes of the stream while limiting the detected type to the provided set of compressor names.
public CompressorInputStream	Returns: compressor input stream createCompressorInputStream(final String of the compressor, i.e. gz, bzip2, xz, lzma, pack200, snappy-raw, snappy-framed, z, lz4-block, lz4-framed, zstd, deflate64 or deflate name, final InputStream the input stream in) Creates a compressor input stream from a compressor name and an input stream.
public CompressorInputStream	createCompressorInputStream(final String of the compressor, i.e. gz, bzip2, xz, lzma, pack200, snappy-raw, snappy-framed, z or deflate name, final InputStream the input stream in, final boolean if true, decompress until the end of the input; if false, stop after the first stream and leave the input position to point to the next byte after the stream. This setting applies to the gzip, bzip2 and XZ formats only. actualDecompressConcatenated) Implements org.apache.commons.compress.compressors.CompressorStreamProvider.createCompressorInputStream. Creates a compressor input stream from a compressor name and an input stream.
public CompressorOutputStream	Returns: the compressor output stream createCompressorOutputStream(final String the compressor name, i.e. gz, bzip2, xz, pack200, snappy-framed, lz4-block, lz4-framed, zstd or deflate name, final OutputStream the output stream out) Implements org.apache.commons.compress.compressors.CompressorStreamProvider.createCompressorOutputStream. Creates a compressor output stream from a compressor name and an output stream.
public static String	Returns: type of compressor stream detected detect(final InputStream input stream inputStream) Detects the type of compressor stream.
pack-priv static String	Returns: type of compressor stream detected detect(final InputStream input stream inputStream, final Set<String> compressor names to limit autodetection compressorNames) Detects the type of compressor stream while limiting the type to the provided set of compressor names.
public static SortedMap<String, CompressorStreamProvider>	Returns: An immutable, map from names to provider objects findAvailableCompressorInputStreamProviders() Constructs a new sorted map from input stream provider names to provider objects.
public static SortedMap<String, CompressorStreamProvider>	Returns: An immutable, map from names to provider objects findAvailableCompressorOutputStreamProviders() Constructs a new sorted map from output stream provider names to provider objects.
public static String	getBrotli()
public static String	getBzip2()
public SortedMap<String, CompressorStreamProvider>	getCompressorInputStreamProviders()
public SortedMap<String, CompressorStreamProvider>	getCompressorOutputStreamProviders()
pack-priv boolean	getDecompressConcatenated() For tests.
public Boolean	getDecompressUntilEOF()
public static String	getDeflate()
public static String	Returns: the constant `DEFLATE64` getDeflate64()
public static String	getGzip()
public Set<String>	getInputStreamCompressorNames() Implements org.apache.commons.compress.compressors.CompressorStreamProvider.getInputStreamCompressorNames. Gets all the input stream compressor names for this provider
public static String	getLZ4Block()
public static String	getLZ4Framed()
public static String	getLzma()
public Set<String>	getOutputStreamCompressorNames() Implements org.apache.commons.compress.compressors.CompressorStreamProvider.getOutputStreamCompressorNames. Gets all the output stream compressor names for this provider
public static String	getPack200()
public static CompressorStreamFactory	getSingleton()
public static String	getSnappyFramed()
public static String	getSnappyRaw()
public static String	getXz()
public static String	getZ()
public static String	getZstandard()
pack-priv static void	putAll(final Set<String> names, final CompressorStreamProvider provider, final TreeMap<String, CompressorStreamProvider> map)
public void	setDecompressConcatenated(final boolean if true, decompress until the end of the input; if false, stop after the first stream and leave the input position to point to the next byte after the stream decompressConcatenated) Deprecated 1.10 use the `CompressorStreamFactory(boolean)` constructor instead Sets whether to decompress the full input or only the first stream in formats supporting multiple concatenated input streams.
private static String	toKey(final String name)
private static String	youNeed(final String name, final String url)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ALL_NAMES	back to summary
private static final Set<String> ALL_NAMES

BROTLI	back to summary
public static final String BROTLI Constant (value br) used to identify the BROTLI compression algorithm. Since 1.14

BROTLI

back to summary

public static final String BROTLI

Constant (value br) used to identify the BROTLI compression algorithm.

Since: 1.14

BZIP2	back to summary
public static final String BZIP2 Constant (value bzip2) used to identify the BZIP2 compression algorithm. Since 1.1

BZIP2

back to summary

public static final String BZIP2

Constant (value bzip2) used to identify the BZIP2 compression algorithm.

Since: 1.1

compressorInputStreamProviders	back to summary
private SortedMap<String, CompressorStreamProvider> compressorInputStreamProviders

compressorOutputStreamProviders	back to summary
private SortedMap<String, CompressorStreamProvider> compressorOutputStreamProviders

decompressConcatenated	back to summary
private volatile boolean decompressConcatenated If true, decompress until the end of the input. If false, stop after the first stream and leave the input position to point to the next byte after the stream

decompressUntilEOF	back to summary
private final Boolean decompressUntilEOF If true, decompress until the end of the input. If false, stop after the first stream and leave the input position to point to the next byte after the stream

DEFLATE	back to summary
public static final String DEFLATE Constant (value deflate) used to identify the Deflate compress method. Since 1.9

DEFLATE

back to summary

public static final String DEFLATE

Constant (value deflate) used to identify the Deflate compress method.

Since: 1.9

DEFLATE64	back to summary
public static final String DEFLATE64 Constant (value deflate64) used to identify the Deflate64 compress method. Since 1.16

DEFLATE64

back to summary

public static final String DEFLATE64

Constant (value deflate64) used to identify the Deflate64 compress method.

Since: 1.16

GZIP	back to summary
public static final String GZIP Constant (value gz) used to identify the GZIP compression algorithm. Since 1.1

GZIP

back to summary

public static final String GZIP

Constant (value gz) used to identify the GZIP compression algorithm.

Since: 1.1

LZ4_BLOCK	back to summary
public static final String LZ4_BLOCK Constant (value lz4-block) used to identify the block LZ4 compression method. Since 1.14

LZ4_BLOCK

back to summary

public static final String LZ4_BLOCK

Constant (value lz4-block) used to identify the block LZ4 compression method.

Since: 1.14

LZ4_FRAMED	back to summary
public static final String LZ4_FRAMED Constant (value lz4-framed) used to identify the frame LZ4 compression method. Since 1.14

LZ4_FRAMED

back to summary

public static final String LZ4_FRAMED

Constant (value lz4-framed) used to identify the frame LZ4 compression method.

Since: 1.14

LZMA	back to summary
public static final String LZMA Constant (value lzma) used to identify the LZMA compression method. Since 1.6

LZMA

back to summary

public static final String LZMA

Constant (value lzma) used to identify the LZMA compression method.

Since: 1.6

memoryLimitInKb	back to summary
private final int memoryLimitInKb

PACK200	back to summary
public static final String PACK200 Constant (value pack200) used to identify the PACK200 compression algorithm. Since 1.3

PACK200

back to summary

public static final String PACK200

Constant (value pack200) used to identify the PACK200 compression algorithm.

Since: 1.3

SINGLETON	back to summary
private static final CompressorStreamFactory SINGLETON

SNAPPY_FRAMED	back to summary
public static final String SNAPPY_FRAMED Constant (value snappy-framed) used to identify the "framed" Snappy compression method. Since 1.7

SNAPPY_FRAMED

back to summary

public static final String SNAPPY_FRAMED

Constant (value snappy-framed) used to identify the "framed" Snappy compression method.

Since: 1.7

SNAPPY_RAW	back to summary
public static final String SNAPPY_RAW Constant (value snappy-raw) used to identify the "raw" Snappy compression method. Not supported as an output stream type. Since 1.7

SNAPPY_RAW

back to summary

public static final String SNAPPY_RAW

Constant (value snappy-raw) used to identify the "raw" Snappy compression method. Not supported as an output stream type.

Since: 1.7

XZ	back to summary
public static final String XZ Constant (value xz) used to identify the XZ compression method. Since 1.4

back to summary

public static final String XZ

Constant (value xz) used to identify the XZ compression method.

Since: 1.4

YOU_NEED_BROTLI_DEC	back to summary
private static final String YOU_NEED_BROTLI_DEC

YOU_NEED_XZ_JAVA	back to summary
private static final String YOU_NEED_XZ_JAVA

YOU_NEED_ZSTD_JNI	back to summary
private static final String YOU_NEED_ZSTD_JNI

Z	back to summary
public static final String Z Constant (value z) used to identify the traditional Unix compress method. Not supported as an output stream type. Since 1.7

back to summary

public static final String Z

Constant (value z) used to identify the traditional Unix compress method. Not supported as an output stream type.

Since: 1.7

ZSTANDARD	back to summary
public static final String ZSTANDARD Constant (value zstd) used to identify the Zstandard compression algorithm. Not supported as an output stream type. Since 1.16

ZSTANDARD

back to summary

public static final String ZSTANDARD

Constant (value zstd) used to identify the Zstandard compression algorithm. Not supported as an output stream type.

Since: 1.16

Constructor Detail

CompressorStreamFactory	back to summary
public CompressorStreamFactory() Constructs an instance with the decompress Concatenated option set to false.

CompressorStreamFactory	back to summary
public CompressorStreamFactory(final boolean decompressUntilEOF) Constructs an instance with the provided decompress Concatenated option. Parameters decompressUntilEOF:boolean if true, decompress until the end of the input; if false, stop after the first stream and leave the input position to point to the next byte after the stream. This setting applies to the gzip, bzip2 and XZ formats only. Since 1.10

CompressorStreamFactory

back to summary

public CompressorStreamFactory(final boolean decompressUntilEOF)

Constructs an instance with the provided decompress Concatenated option.

Parameters

decompressUntilEOF:boolean: if true, decompress until the end of the input; if false, stop after the first stream and leave the input position to point to the next byte after the stream. This setting applies to the gzip, bzip2 and XZ formats only.

Since

1.10

CompressorStreamFactory	back to summary
public CompressorStreamFactory(final boolean decompressUntilEOF, final int memoryLimitInKb) Constructs an instance with the provided decompress Concatenated option. Parameters decompressUntilEOF:boolean if true, decompress until the end of the input; if false, stop after the first stream and leave the input position to point to the next byte after the stream. This setting applies to the gzip, bzip2 and XZ formats only. memoryLimitInKb:int Some streams require allocation of potentially significant byte arrays/tables, and they can offer checks to prevent OOMs on corrupt files. Set the maximum allowed memory allocation in KBs. Since 1.14

CompressorStreamFactory

back to summary

public CompressorStreamFactory(final boolean decompressUntilEOF, final int memoryLimitInKb)

Constructs an instance with the provided decompress Concatenated option.

Parameters

decompressUntilEOF:boolean: if true, decompress until the end of the input; if false, stop after the first stream and leave the input position to point to the next byte after the stream. This setting applies to the gzip, bzip2 and XZ formats only.
memoryLimitInKb:int: Some streams require allocation of potentially significant byte arrays/tables, and they can offer checks to prevent OOMs on corrupt files. Set the maximum allowed memory allocation in KBs.

Since

1.14

Method Detail

archiveStreamProviderIterable	back to summary
private static Iterable<CompressorStreamProvider> archiveStreamProviderIterable()

createCompressorInputStream	back to summary
public CompressorInputStream createCompressorInputStream(final InputStream in) throws CompressorException Creates a compressor input stream from an input stream, auto-detecting the compressor type from the first few bytes of the stream. The InputStream must support marks, like BufferedInputStream. Parameters in:InputStream the input stream Returns:CompressorInputStream the compressor input stream Exceptions CompressorException: if the compressor name is not known IllegalArgumentException: if the stream is null or does not support mark Since 1.1

createCompressorInputStream

back to summary

public CompressorInputStream createCompressorInputStream(final InputStream in) throws CompressorException

Creates a compressor input stream from an input stream, auto-detecting the compressor type from the first few bytes of the stream. The InputStream must support marks, like BufferedInputStream.

Parameters

in:InputStream: the input stream

Returns:CompressorInputStream

the compressor input stream

Exceptions

CompressorException:: if the compressor name is not known
IllegalArgumentException:: if the stream is null or does not support mark

Since

1.1

createCompressorInputStream	back to summary
public CompressorInputStream createCompressorInputStream(final InputStream in, final Set<String> compressorNames) throws CompressorException Creates a compressor input stream from an input stream, auto-detecting the compressor type from the first few bytes of the stream while limiting the detected type to the provided set of compressor names. The InputStream must support marks, like BufferedInputStream. Parameters in:InputStream the input stream compressorNames:Set<String> compressor names to limit autodetection Returns:CompressorInputStream the compressor input stream Exceptions CompressorException: if the autodetected compressor is not in the provided set of compressor names IllegalArgumentException: if the stream is null or does not support mark Since 1.25.0

createCompressorInputStream

back to summary

public CompressorInputStream createCompressorInputStream(final InputStream in, final Set<String> compressorNames) throws CompressorException

Creates a compressor input stream from an input stream, auto-detecting the compressor type from the first few bytes of the stream while limiting the detected type to the provided set of compressor names. The InputStream must support marks, like BufferedInputStream.

Parameters

in:InputStream: the input stream
compressorNames:Set<String>: compressor names to limit autodetection

Returns:CompressorInputStream

the compressor input stream

Exceptions

CompressorException:: if the autodetected compressor is not in the provided set of compressor names
IllegalArgumentException:: if the stream is null or does not support mark

Since

1.25.0

createCompressorInputStream	back to summary
public CompressorInputStream createCompressorInputStream(final String name, final InputStream in) throws CompressorException Creates a compressor input stream from a compressor name and an input stream. Parameters name:String of the compressor, i.e. gz, bzip2, xz, lzma, pack200, snappy-raw, snappy-framed, z, lz4-block, lz4-framed, zstd, deflate64 or deflate in:InputStream the input stream Returns:CompressorInputStream compressor input stream Exceptions CompressorException: if the compressor name is not known or not available, or if there's an IOException or MemoryLimitException thrown during initialization IllegalArgumentException: if the name or input stream is null

createCompressorInputStream

back to summary

public CompressorInputStream createCompressorInputStream(final String name, final InputStream in) throws CompressorException

Creates a compressor input stream from a compressor name and an input stream.

Parameters

name:String: of the compressor, i.e. gz, bzip2, xz, lzma, pack200, snappy-raw, snappy-framed, z, lz4-block, lz4-framed, zstd, deflate64 or deflate
in:InputStream: the input stream

Returns:CompressorInputStream

compressor input stream

Exceptions

CompressorException:: if the compressor name is not known or not available, or if there's an IOException or MemoryLimitException thrown during initialization
IllegalArgumentException:: if the name or input stream is null

createCompressorInputStream	back to summary
public CompressorInputStream createCompressorInputStream(final String name, final InputStream in, final boolean actualDecompressConcatenated) throws CompressorException Implements org.apache.commons.compress.compressors.CompressorStreamProvider.createCompressorInputStream. Doc from org.apache.commons.compress.compressors.CompressorStreamProvider.createCompressorInputStream. Creates a compressor input stream from a compressor name and an input stream. Parameters name:String of the compressor, i.e. gz, bzip2, xz, lzma, pack200, snappy-raw, snappy-framed, z or deflate in:InputStream the input stream actualDecompressConcatenated:boolean if true, decompress until the end of the input; if false, stop after the first stream and leave the input position to point to the next byte after the stream. This setting applies to the gzip, bzip2 and XZ formats only. Returns:CompressorInputStream compressor input stream Annotations @Override Exceptions CompressorException: if the compressor name is not known

createCompressorInputStream

back to summary

public CompressorInputStream createCompressorInputStream(final String name, final InputStream in, final boolean actualDecompressConcatenated) throws CompressorException

Implements org.apache.commons.compress.compressors.CompressorStreamProvider.createCompressorInputStream.

Doc from org.apache.commons.compress.compressors.CompressorStreamProvider.createCompressorInputStream.

Creates a compressor input stream from a compressor name and an input stream.

Parameters

name:String: of the compressor, i.e. gz, bzip2, xz, lzma, pack200, snappy-raw, snappy-framed, z or deflate
in:InputStream: the input stream
actualDecompressConcatenated:boolean: if true, decompress until the end of the input; if false, stop after the first stream and leave the input position to point to the next byte after the stream. This setting applies to the gzip, bzip2 and XZ formats only.

Returns:CompressorInputStream

compressor input stream

Annotations

@Override

Exceptions

CompressorException:: if the compressor name is not known

createCompressorOutputStream	back to summary
public CompressorOutputStream createCompressorOutputStream(final String name, final OutputStream out) throws CompressorException Implements org.apache.commons.compress.compressors.CompressorStreamProvider.createCompressorOutputStream. Creates a compressor output stream from a compressor name and an output stream. Parameters name:String the compressor name, i.e. gz, bzip2, xz, pack200, snappy-framed, lz4-block, lz4-framed, zstd or deflate out:OutputStream the output stream Returns:CompressorOutputStream the compressor output stream Annotations @Override Exceptions CompressorException: if the archiver name is not known IllegalArgumentException: if the archiver name or stream is null

createCompressorOutputStream

back to summary

public CompressorOutputStream createCompressorOutputStream(final String name, final OutputStream out) throws CompressorException

Implements org.apache.commons.compress.compressors.CompressorStreamProvider.createCompressorOutputStream.

Creates a compressor output stream from a compressor name and an output stream.

Parameters

name:String: the compressor name, i.e. gz, bzip2, xz, pack200, snappy-framed, lz4-block, lz4-framed, zstd or deflate
out:OutputStream: the output stream

Returns:CompressorOutputStream

the compressor output stream

Annotations

@Override

Exceptions

CompressorException:: if the archiver name is not known
IllegalArgumentException:: if the archiver name or stream is null

detect	back to summary
public static String detect(final InputStream inputStream) throws CompressorException Detects the type of compressor stream. Parameters inputStream:InputStream input stream Returns:String type of compressor stream detected Exceptions CompressorException: if no compressor stream type was detected or if something else went wrong IllegalArgumentException: if stream is null or does not support mark Since 1.14

detect

back to summary

public static String detect(final InputStream inputStream) throws CompressorException

Detects the type of compressor stream.

Parameters

inputStream:InputStream: input stream

Returns:String

type of compressor stream detected

Exceptions

CompressorException:: if no compressor stream type was detected or if something else went wrong
IllegalArgumentException:: if stream is null or does not support mark

Since

1.14

detect	back to summary
pack-priv static String detect(final InputStream inputStream, final Set<String> compressorNames) throws CompressorException Detects the type of compressor stream while limiting the type to the provided set of compressor names. Parameters inputStream:InputStream input stream compressorNames:Set<String> compressor names to limit autodetection Returns:String type of compressor stream detected Exceptions CompressorException: if no compressor stream type was detected or if something else went wrong IllegalArgumentException: if stream is null or does not support mark

detect

back to summary

pack-priv static String detect(final InputStream inputStream, final Set<String> compressorNames) throws CompressorException

Detects the type of compressor stream while limiting the type to the provided set of compressor names.

Parameters

inputStream:InputStream: input stream
compressorNames:Set<String>: compressor names to limit autodetection

Returns:String

type of compressor stream detected

Exceptions

CompressorException:: if no compressor stream type was detected or if something else went wrong
IllegalArgumentException:: if stream is null or does not support mark

findAvailableCompressorInputStreamProviders	back to summary
public static SortedMap<String, CompressorStreamProvider> findAvailableCompressorInputStreamProviders() Constructs a new sorted map from input stream provider names to provider objects. The map returned by this method will have one entry for each provider for which support is available in the current Java virtual machine. If two or more supported provider have the same name then the resulting map will contain just one of them; which one it will contain is not specified. The invocation of this method, and the subsequent use of the resulting map, may cause time-consuming disk or network I/O operations to occur. This method is provided for applications that need to enumerate all of the available providers, for example to allow user provider selection. This method may return different results at different times if new providers are dynamically made available to the current Java virtual machine. Returns:SortedMap<String, CompressorStreamProvider> An immutable, map from names to provider objects Since 1.13

findAvailableCompressorInputStreamProviders

back to summary

public static SortedMap<String, CompressorStreamProvider> findAvailableCompressorInputStreamProviders()

Constructs a new sorted map from input stream provider names to provider objects.

The map returned by this method will have one entry for each provider for which support is available in the current Java virtual machine. If two or more supported provider have the same name then the resulting map will contain just one of them; which one it will contain is not specified.

The invocation of this method, and the subsequent use of the resulting map, may cause time-consuming disk or network I/O operations to occur. This method is provided for applications that need to enumerate all of the available providers, for example to allow user provider selection.

This method may return different results at different times if new providers are dynamically made available to the current Java virtual machine.

Returns:SortedMap<String, CompressorStreamProvider>: An immutable, map from names to provider objects
Since: 1.13

findAvailableCompressorOutputStreamProviders	back to summary
public static SortedMap<String, CompressorStreamProvider> findAvailableCompressorOutputStreamProviders() Constructs a new sorted map from output stream provider names to provider objects. The map returned by this method will have one entry for each provider for which support is available in the current Java virtual machine. If two or more supported provider have the same name then the resulting map will contain just one of them; which one it will contain is not specified. The invocation of this method, and the subsequent use of the resulting map, may cause time-consuming disk or network I/O operations to occur. This method is provided for applications that need to enumerate all of the available providers, for example to allow user provider selection. This method may return different results at different times if new providers are dynamically made available to the current Java virtual machine. Returns:SortedMap<String, CompressorStreamProvider> An immutable, map from names to provider objects Since 1.13

findAvailableCompressorOutputStreamProviders

back to summary

public static SortedMap<String, CompressorStreamProvider> findAvailableCompressorOutputStreamProviders()

Constructs a new sorted map from output stream provider names to provider objects.

This method may return different results at different times if new providers are dynamically made available to the current Java virtual machine.

Returns:SortedMap<String, CompressorStreamProvider>: An immutable, map from names to provider objects
Since: 1.13

getBrotli	back to summary
public static String getBrotli()

getBzip2	back to summary
public static String getBzip2()

getCompressorInputStreamProviders	back to summary
public SortedMap<String, CompressorStreamProvider> getCompressorInputStreamProviders()

getCompressorOutputStreamProviders	back to summary
public SortedMap<String, CompressorStreamProvider> getCompressorOutputStreamProviders()

getDecompressConcatenated	back to summary
pack-priv boolean getDecompressConcatenated() For tests.

getDecompressUntilEOF	back to summary
public Boolean getDecompressUntilEOF()

getDeflate	back to summary
public static String getDeflate()

getDeflate64	back to summary
public static String getDeflate64() Returns:String the constant `DEFLATE64` Since 1.16

getGzip	back to summary
public static String getGzip()

getInputStreamCompressorNames	back to summary
public Set<String> getInputStreamCompressorNames() Implements org.apache.commons.compress.compressors.CompressorStreamProvider.getInputStreamCompressorNames. Doc from org.apache.commons.compress.compressors.CompressorStreamProvider.getInputStreamCompressorNames. Gets all the input stream compressor names for this provider Returns:Set<String> all the input compressor names for this provider Annotations @Override

getInputStreamCompressorNames

back to summary

public Set<String> getInputStreamCompressorNames()

Implements org.apache.commons.compress.compressors.CompressorStreamProvider.getInputStreamCompressorNames.

Doc from org.apache.commons.compress.compressors.CompressorStreamProvider.getInputStreamCompressorNames.

Gets all the input stream compressor names for this provider

Returns:Set<String>

all the input compressor names for this provider

Annotations

@Override

getLZ4Block	back to summary
public static String getLZ4Block()

getLZ4Framed	back to summary
public static String getLZ4Framed()

getLzma	back to summary
public static String getLzma()

getOutputStreamCompressorNames

back to summary

public Set<String> getOutputStreamCompressorNames()

Implements org.apache.commons.compress.compressors.CompressorStreamProvider.getOutputStreamCompressorNames.

Doc from org.apache.commons.compress.compressors.CompressorStreamProvider.getOutputStreamCompressorNames.

Gets all the output stream compressor names for this provider

Returns:Set<String>

all the output compressor names for this provider

Annotations

@Override

getPack200	back to summary
public static String getPack200()

getSingleton	back to summary
public static CompressorStreamFactory getSingleton()

getSnappyFramed	back to summary
public static String getSnappyFramed()

getSnappyRaw	back to summary
public static String getSnappyRaw()

getXz	back to summary
public static String getXz()

getZ	back to summary
public static String getZ()

getZstandard	back to summary
public static String getZstandard()

putAll	back to summary
pack-priv static void putAll(final Set<String> names, final CompressorStreamProvider provider, final TreeMap<String, CompressorStreamProvider> map)

setDecompressConcatenated back to summary

public void setDecompressConcatenated(final boolean decompressConcatenated)

Deprecated

1.10 use the CompressorStreamFactory(boolean) constructor instead

Sets whether to decompress the full input or only the first stream in formats supporting multiple concatenated input streams.

This setting applies to the gzip, bzip2 and XZ formats only.

Parameters

decompressConcatenated:boolean: if true, decompress until the end of the input; if false, stop after the first stream and leave the input position to point to the next byte after the stream

Annotations

@Deprecated

Exceptions

IllegalStateException:: if the constructor CompressorStreamFactory(boolean) was used to create the factory

Since

1.5

toKey	back to summary
private static String toKey(final String name)

youNeed	back to summary
private static String youNeed(final String name, final String url)

public Class CompressorStreamFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail