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

Class IfAccumulatedFileCount

java.lang.Object

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

All Implemented Interfaces:

PathCondition

@Plugin(name="IfAccumulatedFileCount",
        category="Core",
        printObject=true)
public final class IfAccumulatedFileCount
extends Object
implements PathCondition

PathCondition that accepts paths after some count threshold is exceeded during the file tree walk.

Method Summary

Modifier and Type	Method	Description
boolean	accept(Path basePath, Path relativePath, BasicFileAttributes attrs)	Returns true if the specified candidate path should be deleted, false otherwise.
void	beforeFileTreeWalk()	Invoked before a new file tree walk is started.
static IfAccumulatedFileCount	createFileCountCondition(int threshold, PathCondition... nestedConditions)	Create an IfAccumulatedFileCount condition.
List<PathCondition>	getNestedConditions()
int	getThresholdCount()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getThresholdCount

public int getThresholdCount()

getNestedConditions

public List<PathCondition> getNestedConditions()

accept

public boolean accept(Path basePath,
                      Path relativePath,
                      BasicFileAttributes attrs)

Description copied from interface: PathCondition

Returns true if the specified candidate path should be deleted, false otherwise.

Specified by:

accept in interface PathCondition

Parameters:

basePath - the directory from where to start scanning for deletion candidate files

relativePath - the candidate for deletion. This path is relative to the baseDir.

attrs - attributes of the candidate path

Returns:

whether the candidate path should be deleted

beforeFileTreeWalk

public void beforeFileTreeWalk()

Description copied from interface: PathCondition

Invoked before a new file tree walk is started. Stateful PathConditions can reset their state when this method is called.

Specified by:

beforeFileTreeWalk in interface PathCondition

createFileCountCondition

@PluginFactory
public static IfAccumulatedFileCount createFileCountCondition(@PluginAttribute(value="exceeds",defaultInt=2147483647)
                                                              int threshold,
                                                              @PluginElement("PathConditions")
                                                              PathCondition... nestedConditions)

Create an IfAccumulatedFileCount condition.

Parameters:

threshold - The threshold count from which files will be deleted.

Returns:

An IfAccumulatedFileCount condition.

toString

public String toString()

Overrides:

toString in class Object