org.apache.commons.compress.compressors.bzip2
Class BZip2Compressor

java.lang.Object
  extended by org.apache.commons.compress.PackableObject
      extended by org.apache.commons.compress.AbstractCompressor
          extended by org.apache.commons.compress.compressors.bzip2.BZip2Compressor
All Implemented Interfaces:
org.apache.commons.compress.Compressor

public class BZip2Compressor
extends org.apache.commons.compress.AbstractCompressor

Implementation of the Compressor Interface for BZip2.

Author:
christian.grobmeier

Field Summary
private static java.lang.String DEFAULT_FILE_EXTENSION
           
private static byte[] HEADER
           
private static java.lang.String NAME
           
 
Fields inherited from class org.apache.commons.compress.PackableObject
CHOOSE_EXTENSION, CHOOSE_NAME
 
Constructor Summary
BZip2Compressor()
          Constructor.
 
Method Summary
 void compressTo(java.io.FileInputStream inputStream, java.io.FileOutputStream outputStream)
           
 void decompressTo(java.io.FileInputStream input, java.io.FileOutputStream outputStream)
           
 java.lang.String getDefaultFileExtension()
           
 byte[] getHeader()
           
 java.lang.String getName()
           
private  BZip2InputStream getPackedInput(java.io.InputStream input)
          Skips the 'BZ' header bytes.
private  BZip2OutputStream getPackedOutput(java.io.OutputStream output)
          Writes a 'BZ' header to the output stream, and creates a BZip2OutputStream object ready for use, as required by the BZip2OutputStream class.
 
Methods inherited from class org.apache.commons.compress.AbstractCompressor
compress, compress, compressTo, compressToHere, decompress, decompress, decompressTo
 
Methods inherited from class org.apache.commons.compress.PackableObject
identifyByHeader, isPackableWith
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HEADER

private static final byte[] HEADER

NAME

private static final java.lang.String NAME
See Also:
Constant Field Values

DEFAULT_FILE_EXTENSION

private static java.lang.String DEFAULT_FILE_EXTENSION
Constructor Detail

BZip2Compressor

public BZip2Compressor()
Constructor.

Method Detail

compressTo

public void compressTo(java.io.FileInputStream inputStream,
                       java.io.FileOutputStream outputStream)
                throws org.apache.commons.compress.CompressException
Throws:
org.apache.commons.compress.CompressException

decompressTo

public void decompressTo(java.io.FileInputStream input,
                         java.io.FileOutputStream outputStream)
                  throws org.apache.commons.compress.CompressException
Throws:
org.apache.commons.compress.CompressException

getPackedInput

private BZip2InputStream getPackedInput(java.io.InputStream input)
                                 throws java.io.IOException
Skips the 'BZ' header bytes. required by the BZip2InputStream class.

Parameters:
input - input stream
Returns:
BZip2InputStream instance
Throws:
java.io.IOException - if an IO error occurs

getPackedOutput

private BZip2OutputStream getPackedOutput(java.io.OutputStream output)
                                   throws java.io.IOException
Writes a 'BZ' header to the output stream, and creates a BZip2OutputStream object ready for use, as required by the BZip2OutputStream class.

Parameters:
output - Output stream to add a header to
Returns:
BZip2OutputStream ready to write to
Throws:
java.io.IOException - if an IO error occurs

getHeader

public byte[] getHeader()
Specified by:
getHeader in class org.apache.commons.compress.PackableObject

getName

public java.lang.String getName()
Specified by:
getName in class org.apache.commons.compress.PackableObject

getDefaultFileExtension

public java.lang.String getDefaultFileExtension()
Specified by:
getDefaultFileExtension in class org.apache.commons.compress.AbstractCompressor