org.codehaus.plexus.archiver.util

Class Compressor

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.codehaus.plexus.archiver.util.Compressor

All Implemented Interfaces:

org.codehaus.plexus.logging.LogEnabled

Direct Known Subclasses:

BZip2Compressor, GZipCompressor, SnappyCompressor, XZCompressor

public abstract class Compressor
extends org.codehaus.plexus.logging.AbstractLogEnabled

Constructor Summary

Constructors

Constructor and Description
Compressor()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close() subclasses must implement this method to cleanup after compression this is public so the process of compression and closing can be dealt with separately.
abstract void	compress() subclasses must implement this method to do their compression this is public so the process of compression and closing can be dealt with separately.
protected void	compress(org.codehaus.plexus.components.io.resources.PlexusIoResource resource, OutputStream zOut) compress a resource to an output stream
File	getDestFile()
org.codehaus.plexus.components.io.resources.PlexusIoResource	getSource() The resource to compress; required.
void	setDestFile(File compressFile) the required destination file.
void	setSource(org.codehaus.plexus.components.io.resources.PlexusIoResource source) The resource to compress; required.

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

Compressor

public Compressor()

Method Detail

setDestFile

public void setDestFile(File compressFile)

the required destination file.

Parameters:

compressFile -

getDestFile

public File getDestFile()

setSource

public void setSource(org.codehaus.plexus.components.io.resources.PlexusIoResource source)

The resource to compress; required.

getSource

public org.codehaus.plexus.components.io.resources.PlexusIoResource getSource()

The resource to compress; required.

compress

protected void compress(org.codehaus.plexus.components.io.resources.PlexusIoResource resource,
            OutputStream zOut)
                 throws IOException

compress a resource to an output stream

Throws:

IOException

compress

public abstract void compress()
                       throws ArchiverException

subclasses must implement this method to do their compression this is public so the process of compression and closing can be dealt with separately.

Throws:

ArchiverException

close

public abstract void close()
                    throws ArchiverException

subclasses must implement this method to cleanup after compression this is public so the process of compression and closing can be dealt with separately.

Throws:

ArchiverException