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

Class FileRenameAction

java.lang.Object

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

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

All Implemented Interfaces:

java.lang.Runnable, Action

public class FileRenameAction
extends AbstractAction

File rename action.

Field Summary

Fields

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

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

LOGGER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	execute() Rename file.
static boolean	execute(java.io.File source, java.io.File destination, boolean renameEmptyFiles) Rename file.
java.io.File	getDestination() Gets the destination.
java.io.File	getSource() Gets the source.
boolean	isRenameEmptyFiles() Whether to rename empty files.
java.lang.String	toString()

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

close, isComplete, isInterrupted, reportException, run

Methods inherited from class java.lang.Object

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

Field Detail

source

private final java.io.File source

Source.

destination

private final java.io.File destination

Destination.

renameEmptyFiles

private final boolean renameEmptyFiles

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

Constructor Detail

FileRenameAction

public FileRenameAction(java.io.File src,
                        java.io.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 Detail

execute

public boolean execute()

Rename file.

Specified by:

execute in interface Action

Specified by:

execute in class AbstractAction

Returns:

true if successfully renamed.

getDestination

public java.io.File getDestination()

Gets the destination.

Returns:

the destination.

getSource

public java.io.File getSource()

Gets the source.

Returns:

the source.

isRenameEmptyFiles

public boolean isRenameEmptyFiles()

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

Returns:

Whether to rename empty files.

execute

public static boolean execute(java.io.File source,
                              java.io.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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object