Package ca.cgjennings.algo.compression

Class GZIPCompressor

  • All Implemented Interfaces:
    Compressor
    public class GZIPCompressor
extends AbstractCompressor
    A Compressor that implements GZIP compression; this is the deflate compression algorithm with the header and footer expected by GZIP tools.
    Since:
    3.0
    Author:
    Chris Jennings

    • Constructor Summary

      Constructors 
      Constructor Description
      GZIPCompressor()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void compress​(java.io.InputStream in, java.io.OutputStream out)
      Reads the data from the input stream, compresses it, and writes it to the output stream.
      java.io.InputStream filter​(java.io.InputStream in)
      Returns an input stream that reads decompresses data from a stream of compressed data.
      java.io.OutputStream filter​(java.io.OutputStream out)
      Returns an output stream that compresses data as it writes it to an existing stream.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • GZIPCompressor

        public GZIPCompressor()

    • Method Detail

      • compress

        public void compress​(java.io.InputStream in,
                     java.io.OutputStream out)
              throws java.io.IOException
        Description copied from interface: Compressor
        Reads the data from the input stream, compresses it, and writes it to the output stream.
        Parameters:
        in - the source for data to compress
        out - the sink for compressed data
        Throws:
        java.io.IOException - if an error occurs during compression

      • filter

        public java.io.OutputStream filter​(java.io.OutputStream out)
                            throws java.io.IOException
        Description copied from interface: Compressor
        Returns an output stream that compresses data as it writes it to an existing stream.
        Parameters:
        out - the stream to write compressed data to
        Returns:
        a filter stream that will compress data and write it to out
        Throws:
        java.io.IOException - if an error occurs while creating the stream

      • filter

        public java.io.InputStream filter​(java.io.InputStream in)
                           throws java.io.IOException
        Description copied from interface: Compressor
        Returns an input stream that reads decompresses data from a stream of compressed data.
        Parameters:
        in - the stream to read compressed data from
        Returns:
        a filter stream that will decompress data from in as it is read from
        Throws:
        java.io.IOException - if an error occurs while creating the stream