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

Class DeletingVisitor

java.lang.Object

java.nio.file.SimpleFileVisitor<Path>

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

All Implemented Interfaces:

FileVisitor<Path>

public class DeletingVisitor
extends SimpleFileVisitor<Path>

FileVisitor that deletes files that are accepted by all PathFilters. Directories are ignored.

Constructor Summary

Constructors

Constructor	Description
DeletingVisitor(Path basePath, List<? extends PathCondition> pathConditions, boolean testMode)	Constructs a new DeletingVisitor.

Method Summary

Modifier and Type	Method	Description
protected void	delete(Path file)	Deletes the specified file.
boolean	isTestMode()	Returns true if files are not deleted even when all conditions accept a path, false otherwise.
FileVisitResult	visitFile(Path file, BasicFileAttributes attrs)
FileVisitResult	visitFileFailed(Path file, IOException ioException)

Methods inherited from class java.nio.file.SimpleFileVisitor

postVisitDirectory, preVisitDirectory

Methods inherited from class java.lang.Object

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

Constructor Detail

DeletingVisitor

public DeletingVisitor(Path basePath,
                       List<? extends PathCondition> pathConditions,
                       boolean testMode)

Constructs a new DeletingVisitor.

Parameters:

basePath - used to relativize paths

pathConditions - objects that need to confirm whether a file can be deleted

testMode - if true, files are not deleted but instead a message is printed to the status logger at INFO level. Users can use this to do a dry run to test if their configuration works as expected.

Method Detail

visitFile

public FileVisitResult visitFile(Path file,
                                 BasicFileAttributes attrs)
                          throws IOException

Specified by:

visitFile in interface FileVisitor<Path>

Overrides:

visitFile in class SimpleFileVisitor<Path>

Throws:

IOException

visitFileFailed

public FileVisitResult visitFileFailed(Path file,
                                       IOException ioException)
                                throws IOException

Specified by:

visitFileFailed in interface FileVisitor<Path>

Overrides:

visitFileFailed in class SimpleFileVisitor<Path>

Throws:

IOException

delete

protected void delete(Path file)
               throws IOException

Deletes the specified file.

Parameters:

file - the file to delete

Throws:

IOException - if a problem occurred deleting the file

isTestMode

public boolean isTestMode()

Returns true if files are not deleted even when all conditions accept a path, false otherwise.

Returns:

true if files are not deleted even when all conditions accept a path, false otherwise