Class GzipUtils
- java.lang.Object
-
- org.apache.commons.compress.compressors.gzip.GzipUtils
-
public class GzipUtils extends java.lang.Object
Utility code for the gzip compression format.
-
-
Field Summary
Fields Modifier and Type Field Description private static FileNameUtil
fileNameUtil
(package private) static java.nio.charset.Charset
GZIP_ENCODING
Encoding for file name and comments per the GZIP File Format Specification
-
Constructor Summary
Constructors Modifier Constructor Description private
GzipUtils()
Private constructor to prevent instantiation of this utility class.
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static java.lang.String
getCompressedFilename(java.lang.String fileName)
Deprecated.static java.lang.String
getCompressedFileName(java.lang.String fileName)
Maps the given file name to the name that the file should have after compression with gzip.static java.lang.String
getUncompressedFilename(java.lang.String fileName)
Deprecated.static java.lang.String
getUncompressedFileName(java.lang.String fileName)
Maps the given name of a gzip-compressed file to the name that the file should have after uncompression.static boolean
isCompressedFilename(java.lang.String fileName)
Deprecated.static boolean
isCompressedFileName(java.lang.String fileName)
Detects common gzip suffixes in the given file name.
-
-
-
Field Detail
-
fileNameUtil
private static final FileNameUtil fileNameUtil
-
GZIP_ENCODING
static final java.nio.charset.Charset GZIP_ENCODING
Encoding for file name and comments per the GZIP File Format Specification
-
-
Method Detail
-
getCompressedFilename
@Deprecated public static java.lang.String getCompressedFilename(java.lang.String fileName)
Deprecated.Maps the given file name to the name that the file should have after compression with gzip. 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.tgz". If no custom mapping is applicable, then the default ".gz" suffix is appended to the file name.- Parameters:
fileName
- name of a file- Returns:
- name of the corresponding compressed file
-
getCompressedFileName
public static java.lang.String getCompressedFileName(java.lang.String fileName)
Maps the given file name to the name that the file should have after compression with gzip. 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.tgz". If no custom mapping is applicable, then the default ".gz" 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 public static java.lang.String getUncompressedFilename(java.lang.String fileName)
Deprecated.Maps the given name of a gzip-compressed file to the name that the file should have after uncompression. Commonly used file type specific suffixes like ".tgz" or ".svgz" are automatically detected and correctly mapped. For example the name "package.tgz" is mapped to "package.tar". And any file names with the generic ".gz" suffix (or any other generic gzip suffix) is mapped to a name without that suffix. If no gzip suffix is detected, then the file name is returned unmapped.- Parameters:
fileName
- name of a file- Returns:
- name of the corresponding uncompressed file
-
getUncompressedFileName
public static java.lang.String getUncompressedFileName(java.lang.String fileName)
Maps the given name of a gzip-compressed file to the name that the file should have after uncompression. Commonly used file type specific suffixes like ".tgz" or ".svgz" are automatically detected and correctly mapped. For example the name "package.tgz" is mapped to "package.tar". And any file names with the generic ".gz" suffix (or any other generic gzip suffix) is mapped to a name without that suffix. If no gzip 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 public static boolean isCompressedFilename(java.lang.String fileName)
Deprecated.Detects common gzip suffixes in the given file name.- Parameters:
fileName
- name of a file- Returns:
true
if the file name has a common gzip suffix,false
otherwise
-
isCompressedFileName
public static boolean isCompressedFileName(java.lang.String fileName)
Detects common gzip suffixes in the given file name.- Parameters:
fileName
- name of a file- Returns:
true
if the file name has a common gzip suffix,false
otherwise- Since:
- 1.25.0
-
-