Class CommonsCompressAction

  • All Implemented Interfaces:
    java.lang.Runnable, Action

    public final class CommonsCompressAction
    extends AbstractAction
    Compresses a file using bzip2 compression.
    • Field Summary

      • Fields inherited from class org.apache.logging.log4j.core.appender.rolling.action.AbstractAction

        LOGGER
    • Constructor Summary

      Constructors 
      Constructor Description
      CommonsCompressAction​(java.lang.String name, java.io.File source, java.io.File destination, boolean deleteSource)
      Creates new instance of Bzip2CompressAction.
    • Constructor Detail

      • CommonsCompressAction

        public CommonsCompressAction​(java.lang.String name,
                                     java.io.File source,
                                     java.io.File destination,
                                     boolean deleteSource)
        Creates new instance of Bzip2CompressAction.
        Parameters:
        name - the compressor name. One of "gz", "bzip2", "xz", "pack200", or "deflate".
        source - file to compress, may not be null.
        destination - compressed file, may not be null.
        deleteSource - if true, attempt to delete file on completion. Failure to delete does not cause an exception to be thrown or affect return value.
    • Method Detail

      • execute

        public boolean execute()
                        throws java.io.IOException
        Compresses.
        Specified by:
        execute in interface Action
        Specified by:
        execute in class AbstractAction
        Returns:
        true if successfully compressed.
        Throws:
        java.io.IOException - on IO exception.
      • execute

        public static boolean execute​(java.lang.String name,
                                      java.io.File source,
                                      java.io.File destination,
                                      boolean deleteSource)
                               throws java.io.IOException
        Compresses a file.
        Parameters:
        name - the compressor name, i.e. "gz", "bzip2", "xz", "pack200", or "deflate".
        source - file to compress, may not be null.
        destination - compressed file, may not be null.
        deleteSource - if true, attempt to delete file on completion. Failure to delete does not cause an exception to be thrown or affect return value.
        Returns:
        true if source file compressed.
        Throws:
        java.io.IOException - on IO exception.
      • reportException

        protected void reportException​(java.lang.Exception ex)
        Reports exception.
        Overrides:
        reportException in class AbstractAction
        Parameters:
        ex - exception.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getName

        public java.lang.String getName()
      • getSource

        public java.io.File getSource()
      • getDestination

        public java.io.File getDestination()
      • isDeleteSource

        public boolean isDeleteSource()