Class Compressor

  • All Implemented Interfaces:
    org.codehaus.plexus.logging.LogEnabled
    Direct Known Subclasses:
    BZip2Compressor, GZipCompressor, XZCompressor

    public abstract class Compressor
    extends org.codehaus.plexus.logging.AbstractLogEnabled
    • Constructor Summary

      Constructors 
      Constructor Description
      Compressor()  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method 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, java.io.OutputStream zOut)
      compress a resource to an output stream
      java.io.File getDestFile()  
      org.codehaus.plexus.components.io.resources.PlexusIoResource getSource()
      The resource to compress; required.
      void setDestFile​(java.io.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​(java.io.File compressFile)
        the required destination file.
        Parameters:
        compressFile -
      • getDestFile

        public java.io.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,
                                java.io.OutputStream zOut)
                         throws java.io.IOException
        compress a resource to an output stream
        Throws:
        java.io.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