Class CommonsCompressAction

java.lang.Object

org.apache.logging.log4j.core.appender.rolling.action.AbstractAction

org.apache.logging.log4j.core.appender.rolling.action.CommonsCompressAction

All Implemented Interfaces:

Runnable, Action

public final class CommonsCompressAction
extends AbstractAction

Compresses a file using bzip2 compression.

Field Summary

Fields

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

Fields inherited from class AbstractAction

LOGGER

Constructor Summary

Constructors

Constructor	Description
CommonsCompressAction(String name, File source, File destination, boolean deleteSource)	Creates new instance of Bzip2CompressAction.

Method Summary

Modifier and Type	Method	Description
boolean	execute()	Compresses.
static boolean	execute(String name, File source, File destination, boolean deleteSource)	Compresses a file.
File	getDestination()
String	getName()
File	getSource()
boolean	isDeleteSource()
protected void	reportException(Exception ex)	Reports exception.
String	toString()

Methods inherited from class AbstractAction

close, isComplete, isInterrupted, run

Methods inherited from class Object

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

Field Details

BUF_SIZE

private static final int BUF_SIZE

See Also:

• Constant Field Values

name

private final String name

Compressor name. One of "gz", "bzip2", "xz", "pack200" or "deflate".

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

CommonsCompressAction

public CommonsCompressAction(String name,
 File source,
 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 Details

execute

public boolean execute()
                throws IOException

Compresses.

Specified by:

execute in interface Action

Specified by:

execute in class AbstractAction

Returns:

true if successfully compressed.

Throws:

IOException - on IO exception.

execute

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

IOException - on IO exception.

reportException

protected void reportException(Exception ex)

Reports exception.

Overrides:

reportException in class AbstractAction

Parameters:

ex - exception.

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

getSource

public File getSource()

getDestination

public File getDestination()

isDeleteSource

public boolean isDeleteSource()