org.codehaus.plexus.archiver.util

Class Compressor

Known Direct Subclasses:
BZip2Compressor, GZipCompressor

public abstract class Compressor
extends AbstractLogEnabled

Version:
$Revision: 2436 $ $Date: 2005-09-01 13:20:41 -0400 (Thu, 01 Sep 2005) $

Field Summary

private File
destFile
private File
sourceFile

Method Summary

protected abstract void
compress()
subclasses must implement this method to do their compression
protected void
compressFile(File file, OutputStream zOut)
compress a file to an output stream
private void
compressFile(InputStream in, OutputStream zOut)
compress a stream to an output stream
void
execute()
validate, then hand off to the subclass
File
getDestFile()
File
getSourceFile()
void
setDestFile(File compressFile)
the required destination file.
void
setSourceFile(File srcFile)
the file to compress; required.
private void
validate()
validation routine

Field Details

destFile

private File destFile

sourceFile

private File sourceFile

Method Details

compress

protected abstract void compress()
            throws ArchiverException
subclasses must implement this method to do their compression

compressFile

protected void compressFile(File file,
                            OutputStream zOut)
            throws IOException
compress a file to an output stream
Parameters:
file -
zOut -

compressFile

private void compressFile(InputStream in,
                          OutputStream zOut)
            throws IOException
compress a stream to an output stream
Parameters:
in -
zOut -

execute

public void execute()
            throws ArchiverException
validate, then hand off to the subclass

getDestFile

public File getDestFile()

getSourceFile

public File getSourceFile()

setDestFile

public void setDestFile(File compressFile)
the required destination file.
Parameters:
compressFile -

setSourceFile

public void setSourceFile(File srcFile)
the file to compress; required.
Parameters:
srcFile -

validate

private void validate()
            throws ArchiverException
validation routine
Throws:
ArchiverException - if anything is invalid