Package org.apache.commons.compress.compressors.gzip

Class GzipUtils

java.lang.Object
org.apache.commons.compress.compressors.gzip.GzipUtils
public class GzipUtils extends Object
Utility code for the GZIP compression format.
See Also:

  • Field Details

    • FCOMMENT

      static final int FCOMMENT
      Header flag indicating a comment follows the header.
      See Also:

    • FEXTRA

      static final int FEXTRA
      Header flag indicating an EXTRA subfields collection follows the header.
      See Also:

    • FHCRC

      static final int FHCRC
      Header flag indicating a header CRC follows the header.
      See Also:

    • fileNameUtil

      private static final FileNameUtil fileNameUtil

    • FNAME

      static final int FNAME
      Header flag indicating a file name follows the header.
      See Also:

    • FRESERVED

      static final int FRESERVED
      See Also:

    • GZIP_ENCODING

      static final Charset GZIP_ENCODING
      Charset for file name and comments per the GZIP File Format Specification.

    • ID1

      static final int ID1
      Member header ID1 (IDentification 1). See RFC1952 2.3.1. Member header and trailer.
      See Also:

    • ID2

      static final int ID2
      Member header ID2 (IDentification 2). See RFC1952 2.3.1. Member header and trailer.
      See Also:

    • XFL_MAX_COMPRESSION

      static final byte XFL_MAX_COMPRESSION
      Member header XFL (eXtra FLags) when the "deflate" method (CM = 8) is set, then XFL = 2 means the compressor used maximum compression (slowest algorithm). See RFC1952 2.3.1. Member header and trailer.
      See Also:

    • XFL_MAX_SPEED

      static final byte XFL_MAX_SPEED
      Member header XFL (eXtra FLags) when the "deflate" method (CM = 8) is set, then XFL = 4 means the compressor used the fastest algorithm. See RFC1952 2.3.1. Member header and trailer.
      See Also:

    • XFL_UNKNOWN

      static final byte XFL_UNKNOWN
      See Also:

  • Constructor Details

    • GzipUtils

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

  • Method Details

    • getCompressedFilename

      @Deprecated public static String getCompressedFilename(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 - name of a file
      Returns:
      name of the corresponding compressed file

    • getCompressedFileName

      public static String getCompressedFileName(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 String getUncompressedFilename(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 - name of a file
      Returns:
      name of the corresponding uncompressed file

    • getUncompressedFileName

      public static String getUncompressedFileName(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(String fileName)
      Deprecated.
      Use isCompressedFileName(String).
      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(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