Class XZUtils
java.lang.Object
org.apache.commons.compress.compressors.xz.XZUtils
Utility code for the XZ compression format.
- Since:
- 1.4
- This class is thread-safe
-
Method Summary
Modifier and TypeMethodDescriptionstatic StringgetCompressedFilename(String fileName) Deprecated.static StringgetCompressedFileName(String fileName) Maps the given file name to the name that the file should have after compression with xz.static StringgetUncompressedFilename(String fileName) Deprecated.static StringgetUncompressedFileName(String fileName) Maps the given name of a xz-compressed file to the name that the file should have after uncompression.static booleanisCompressedFilename(String fileName) Deprecated.static booleanisCompressedFileName(String fileName) Detects common xz suffixes in the given file name.static booleanAre the classes required to support XZ compression available?static booleanmatches(byte[] signature, int length) Checks if the signature matches what is expected for a .xz file.static voidsetCacheXZAvailablity(boolean doCache) Whether to cache the result of the XZ for Java check.
-
Method Details
-
getCompressedFilename
Deprecated.Maps the given file name to the name that the file should have after compression with xz. Common file types with custom suffixes for compressed versions are automatically detected and correctly mapped. For example the name "package.tar" is mapped to "package.txz". If no custom mapping is applicable, then the default ".xz" suffix is appended to the file name.- Parameters:
fileName- name of a file- Returns:
- name of the corresponding compressed file
-
getCompressedFileName
Maps the given file name to the name that the file should have after compression with xz. Common file types with custom suffixes for compressed versions are automatically detected and correctly mapped. For example the name "package.tar" is mapped to "package.txz". If no custom mapping is applicable, then the default ".xz" suffix is appended to the file name.- Parameters:
fileName- name of a file- Returns:
- name of the corresponding compressed file
- Since:
- 1.25.0
-
getUncompressedFilename
Deprecated.Maps the given name of a xz-compressed file to the name that the file should have after uncompression. Commonly used file type specific suffixes like ".txz" are automatically detected and correctly mapped. For example the name "package.txz" is mapped to "package.tar". And any file names with the generic ".xz" suffix (or any other generic xz suffix) is mapped to a name without that suffix. If no xz suffix is detected, then the file name is returned unmapped.- Parameters:
fileName- name of a file- Returns:
- name of the corresponding uncompressed file
-
getUncompressedFileName
Maps the given name of a xz-compressed file to the name that the file should have after uncompression. Commonly used file type specific suffixes like ".txz" are automatically detected and correctly mapped. For example the name "package.txz" is mapped to "package.tar". And any file names with the generic ".xz" suffix (or any other generic xz suffix) is mapped to a name without that suffix. If no xz suffix is detected, then the file name is returned unmapped.- Parameters:
fileName- name of a file- Returns:
- name of the corresponding uncompressed file
- Since:
- 1.25.0
-
isCompressedFilename
Deprecated.Detects common xz suffixes in the given file name.- Parameters:
fileName- name of a file- Returns:
trueif the file name has a common xz suffix,falseotherwise
-
isCompressedFileName
Detects common xz suffixes in the given file name.- Parameters:
fileName- name of a file- Returns:
trueif the file name has a common xz suffix,falseotherwise- Since:
- 1.25.0
-
isXZCompressionAvailable
Are the classes required to support XZ compression available?- Returns:
- true if the classes required to support XZ compression are available
- Since:
- 1.5
-
matches
Checks if the signature matches what is expected for a .xz file.This is more or less a copy of the version found in
XZCompressorInputStreambut doesn't depend on the presence of XZ for Java.- Parameters:
signature- the bytes to checklength- the number of bytes to check- Returns:
- true if signature matches the .xz magic bytes, false otherwise
- Since:
- 1.9
-
setCacheXZAvailablity
Whether to cache the result of the XZ for Java check.This defaults to
falsein an OSGi environment andtrueotherwise.- Parameters:
doCache- whether to cache the result- Since:
- 1.9
-
getCompressedFileName(String).