Apache Commons Compress 1.26.0 · org.apache.commons.compress.compressors.gzip.GzipUtils

Modifier and Type	Field and Description
private static final FileNameUtil	fileNameUtil
pack-priv static final Charset	GZIP_ENCODING Encoding for file name and comments per the GZIP File Format Specification

Access	Constructor and Description
private	GzipUtils() Private constructor to prevent instantiation of this utility class.

Method Summary

Modifier and Type	Method and Description
public static String	Returns: name of the corresponding compressed file getCompressedFilename(final String name of a file fileName) Deprecated Use `getCompressedFileName(String)`. Maps the given file name to the name that the file should have after compression with gzip.
public static String	Returns: name of the corresponding compressed file getCompressedFileName(final String name of a file fileName) Maps the given file name to the name that the file should have after compression with gzip.
public static String	Returns: name of the corresponding uncompressed file getUncompressedFilename(final String name of a file fileName) Deprecated Use `getUncompressedFileName(String)`. Maps the given name of a gzip-compressed file to the name that the file should have after uncompression.
public static String	Returns: name of the corresponding uncompressed file getUncompressedFileName(final String name of a file fileName) Maps the given name of a gzip-compressed file to the name that the file should have after uncompression.
public static boolean	Returns: `true` if the file name has a common gzip suffix, `false` otherwise isCompressedFilename(final String name of a file fileName) Deprecated Use `isCompressedFileName(String)`. Detects common gzip suffixes in the given file name.
public static boolean	Returns: `true` if the file name has a common gzip suffix, `false` otherwise isCompressedFileName(final String name of a file fileName) Detects common gzip suffixes in the given file name.

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

fileNameUtil	back to summary
private static final FileNameUtil fileNameUtil

GZIP_ENCODING	back to summary
pack-priv static final Charset GZIP_ENCODING Encoding for file name and comments per the GZIP File Format Specification

GzipUtils	back to summary
private GzipUtils() Private constructor to prevent instantiation of this utility class.

Method Detail

getCompressedFilename back to summary

getCompressedFilename	back to summary
public static String getCompressedFilename(final String fileName) Deprecated Use `getCompressedFileName(String)`. 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:String name of a file Returns:String name of the corresponding compressed file Annotations @Deprecated

public static String getCompressedFilename(final String fileName)

Deprecated

Use getCompressedFileName(String).

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:String: name of a file

Returns:String

name of the corresponding compressed file

Annotations

@Deprecated

getCompressedFileName	back to summary
public static String getCompressedFileName(final 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:String name of a file Returns:String name of the corresponding compressed file Since 1.25.0

getCompressedFileName

back to summary

public static String getCompressedFileName(final String fileName)

Parameters

fileName:String: name of a file

Returns:String

name of the corresponding compressed file

Since

1.25.0

getUncompressedFilename back to summary

getUncompressedFilename	back to summary
public static String getUncompressedFilename(final String fileName) Deprecated Use `getUncompressedFileName(String)`. 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:String name of a file Returns:String name of the corresponding uncompressed file Annotations @Deprecated

public static String getUncompressedFilename(final String fileName)

Deprecated

Use getUncompressedFileName(String).

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:String: name of a file

Returns:String

name of the corresponding uncompressed file

Annotations

@Deprecated

getUncompressedFileName	back to summary
public static String getUncompressedFileName(final 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:String name of a file Returns:String name of the corresponding uncompressed file Since 1.25.0

getUncompressedFileName

back to summary

public static String getUncompressedFileName(final String fileName)

Parameters

fileName:String: name of a file

Returns:String

name of the corresponding uncompressed file

Since

1.25.0

isCompressedFilename back to summary

isCompressedFilename	back to summary
public static boolean isCompressedFilename(final String fileName) Deprecated Use `isCompressedFileName(String)`. Detects common gzip suffixes in the given file name. Parameters fileName:String name of a file Returns:boolean `true` if the file name has a common gzip suffix, `false` otherwise Annotations @Deprecated

public static boolean isCompressedFilename(final String fileName)

Deprecated

Use isCompressedFileName(String).

Detects common gzip suffixes in the given file name.

Parameters

fileName:String: name of a file

Returns:boolean

true if the file name has a common gzip suffix, false otherwise

Annotations

@Deprecated

isCompressedFileName back to summary

isCompressedFileName	back to summary
public static boolean isCompressedFileName(final String fileName) Detects common gzip suffixes in the given file name. Parameters fileName:String name of a file Returns:boolean `true` if the file name has a common gzip suffix, `false` otherwise Since 1.25.0

public static boolean isCompressedFileName(final String fileName)

Detects common gzip suffixes in the given file name.

Parameters

fileName:String: name of a file

Returns:boolean

true if the file name has a common gzip suffix, false otherwise

Since

1.25.0

public Class GzipUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail