Class LZMAUtils
java.lang.Object
org.apache.commons.compress.compressors.lzma.LZMAUtils
Utility code for the lzma compression format.
- Since:
- 1.10
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static LZMAUtils.CachedAvailability
private static final FileNameUtil
private static final byte[]
LZMA Header Magic Bytes begin a LZMA file. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Private constructor to prevent instantiation of this utility class. -
Method Summary
Modifier and TypeMethodDescription(package private) static LZMAUtils.CachedAvailability
static String
getCompressedFilename
(String fileName) Maps the given file name to the name that the file should have after compression with lzma.static String
getUncompressedFilename
(String fileName) Maps the given name of a lzma-compressed file to the name that the file should have after uncompression.private static boolean
static boolean
isCompressedFilename
(String fileName) Detects common lzma suffixes in the given file name.static boolean
Are the classes required to support LZMA compression available?static boolean
matches
(byte[] signature, int length) Checks if the signature matches what is expected for a .lzma file.static void
setCacheLZMAAvailablity
(boolean doCache) Whether to cache the result of the LZMA check.
-
Field Details
-
fileNameUtil
-
HEADER_MAGIC
private static final byte[] HEADER_MAGICLZMA Header Magic Bytes begin a LZMA file. -
cachedLZMAAvailability
-
-
Constructor Details
-
LZMAUtils
private LZMAUtils()Private constructor to prevent instantiation of this utility class.
-
-
Method Details
-
matches
public static boolean matches(byte[] signature, int length) Checks if the signature matches what is expected for a .lzma file.- Parameters:
signature
- the bytes to checklength
- the number of bytes to check- Returns:
- true if signature matches the .lzma magic bytes, false otherwise
-
isLZMACompressionAvailable
public static boolean isLZMACompressionAvailable()Are the classes required to support LZMA compression available?- Returns:
- true if the classes required to support LZMA compression are available
-
internalIsLZMACompressionAvailable
private static boolean internalIsLZMACompressionAvailable() -
isCompressedFilename
Detects common lzma suffixes in the given file name.- Parameters:
fileName
- name of a file- Returns:
true
if the file name has a common lzma suffix,false
otherwise
-
getUncompressedFilename
Maps the given name of a lzma-compressed file to the name that the file should have after uncompression. Any file names with the generic ".lzma" suffix (or any other generic lzma suffix) is mapped to a name without that suffix. If no lzma suffix is detected, then the file name is returned unmapped.- Parameters:
fileName
- name of a file- Returns:
- name of the corresponding uncompressed file
-
getCompressedFilename
Maps the given file name to the name that the file should have after compression with lzma.- Parameters:
fileName
- name of a file- Returns:
- name of the corresponding compressed file
-
setCacheLZMAAvailablity
public static void setCacheLZMAAvailablity(boolean doCache) Whether to cache the result of the LZMA check.This defaults to
false
in an OSGi environment andtrue
otherwise.- Parameters:
doCache
- whether to cache the result
-
getCachedLZMAAvailability
-