org.apache.log4j.rolling.helper
Class ZipCompressAction

java.lang.Object
  extended by org.apache.log4j.rolling.helper.ActionBase
      extended by org.apache.log4j.rolling.helper.ZipCompressAction
All Implemented Interfaces:
java.lang.Runnable, Action

public final class ZipCompressAction
extends ActionBase

Compresses a file using Zip compression.

Author:
Curt Arnold

Constructor Summary
ZipCompressAction(java.io.File source, java.io.File destination, boolean deleteSource)
          Create new instance of GZCompressAction.
 
Method Summary
 boolean execute()
          Compress.
static boolean execute(java.io.File source, java.io.File destination, boolean deleteSource)
          Compress a file.
protected  void reportException(java.lang.Exception ex)
          Capture exception.
 
Methods inherited from class org.apache.log4j.rolling.helper.ActionBase
close, isComplete, run
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ZipCompressAction

public ZipCompressAction(java.io.File source,
                         java.io.File destination,
                         boolean deleteSource)
Create new instance of GZCompressAction.

Parameters:
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
Compress.

Specified by:
execute in interface Action
Specified by:
execute in class ActionBase
Returns:
true if successfully compressed.
Throws:
java.io.IOException - on IO exception.

execute

public static boolean execute(java.io.File source,
                              java.io.File destination,
                              boolean deleteSource)
                       throws java.io.IOException
Compress a file.

Parameters:
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)
Capture exception.

Overrides:
reportException in class ActionBase
Parameters:
ex - exception.


Copyright © 2010 The Apache Software Foundation. Licensed under the Apache License, Version 2.0

Apache Extras Companion for Apache log4j, Apache log4j and Apache are trademarks of the Apache Software Foundation.