Package ca.cgjennings.algo.compression

Class BZip2Compressor

  • All Implemented Interfaces:
    Compressor
    public class BZip2Compressor
extends AbstractCompressor
    A Compressor that implements the BZip2 compression algorithm.
    Since:
    3.0
    Author:
    Chris Jennings

    • Constructor Summary

      Constructors 
      Constructor Description
      BZip2Compressor()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void compress​(java.io.File in, java.io.File out)
      Compresses a file, writing the result to another file.
      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.
      void decompress​(java.io.InputStream in, java.io.OutputStream out)
      Reads compressed data from the input stream, decompresses 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

      • BZip2Compressor

        public BZip2Compressor()

    • 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

      • decompress

        public void decompress​(java.io.InputStream in,
                       java.io.OutputStream out)
                throws java.io.IOException
        Description copied from interface: Compressor
        Reads compressed data from the input stream, decompresses it, and writes it to the output stream.
        Specified by:
        decompress in interface Compressor
        Overrides:
        decompress in class AbstractCompressor
        Parameters:
        in - the source of data to decompress
        out - the sink for decompressed data
        Throws:
        java.io.IOException - if an error occurs during decompression

      • compress

        public void compress​(java.io.File in,
                     java.io.File out)
              throws java.io.IOException
        Description copied from interface: Compressor
        Compresses a file, writing the result to another file.
        Specified by:
        compress in interface Compressor
        Overrides:
        compress in class AbstractCompressor
        Parameters:
        in - the file to compress
        out - the destination
        Throws:
        java.io.IOException - if an error occurs

      • 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