Class FileRenameAction

java.lang.Object

org.apache.log4j.rolling.helper.ActionBase

org.apache.log4j.rolling.helper.FileRenameAction

All Implemented Interfaces:

Runnable, Action

public final class FileRenameAction
extends ActionBase

File rename action.

Field Summary

Fields

Modifier and Type	Field	Description
private final File	destination	Destination.
private final boolean	renameEmptyFiles	If true, rename empty files, otherwise delete empty files.
private final File	source	Source.

Constructor Summary

Constructors

Constructor	Description
FileRenameAction(File src, File dst, boolean renameEmptyFiles)	Creates an FileRenameAction.

Method Summary

Modifier and Type	Method	Description
boolean	execute()	Rename file.
static boolean	execute(File source, File destination, boolean renameEmptyFiles)	Rename file.

Methods inherited from class ActionBase

close, isComplete, reportException, 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.

destination

private final File destination

Destination.

renameEmptyFiles

private final boolean renameEmptyFiles

If true, rename empty files, otherwise delete empty files.

Constructor Details

FileRenameAction

public FileRenameAction(File src,
 File dst,
 boolean renameEmptyFiles)

Creates an FileRenameAction.

Parameters:

src - current file name.

dst - new file name.

renameEmptyFiles - if true, rename file even if empty, otherwise delete empty files.

Method Details

execute

public boolean execute()

Rename file.

Specified by:

execute in interface Action

Specified by:

execute in class ActionBase

Returns:

true if successfully renamed.

execute

public static boolean execute(File source,
 File destination,
 boolean renameEmptyFiles)

Rename file.

Parameters:

source - current file name.

destination - new file name.

renameEmptyFiles - if true, rename file even if empty, otherwise delete empty files.

Returns:

true if successfully renamed.