Class GZCompressAction

java.lang.Object

org.apache.log4j.rolling.helper.ActionBase

org.apache.log4j.rolling.helper.GZCompressAction

All Implemented Interfaces:

Runnable, Action

public final class GZCompressAction
extends ActionBase

Compresses a file using GZ compression.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	deleteSource	If true, attempt to delete file on completion.
private final File	destination	Destination file.
private final File	source	Source file.

Constructor Summary

Constructors

Constructor	Description
GZCompressAction(File source, File destination, boolean deleteSource)	Create new instance of GZCompressAction.

Method Summary

Modifier and Type	Method	Description
boolean	execute()	Compress.
static boolean	execute(File source, File destination, boolean deleteSource)	Compress a file.
protected void	reportException(Exception ex)	Capture exception.

Methods inherited from class ActionBase

close, isComplete, run

Methods inherited from class Object

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

Field Details

source

private final File source

Source file.

destination

private final File destination

Destination file.

deleteSource

private final boolean deleteSource

If true, attempt to delete file on completion.

Constructor Details

GZCompressAction

public GZCompressAction(File source,
 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 Details

execute

public boolean execute()
                throws IOException

Compress.

Specified by:

execute in interface Action

Specified by:

execute in class ActionBase

Returns:

true if successfully compressed.

Throws:

IOException - on IO exception.

execute

public static boolean execute(File source,
 File destination,
 boolean deleteSource)
                       throws 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:

IOException - on IO exception.

reportException

protected void reportException(Exception ex)

Capture exception.

Overrides:

reportException in class ActionBase

Parameters:

ex - exception.