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.
-
Field Summary
Fields inherited from interface org.apache.logging.log4j.core.appender.rolling.action.PathCondition
EMPTY_ARRAY
-
Method Summary
Modifier and TypeMethodDescriptionboolean
accept
(Path basePath, Path relativePath, BasicFileAttributes attrs) Returnstrue
if the specified candidate path should be deleted,false
otherwise.void
Invoked before a new file tree walk is started.static IfAccumulatedFileCount
createFileCountCondition
(int threshold, PathCondition... nestedConditions) Create an IfAccumulatedFileCount condition.int
toString()
-
Method Details
-
getThresholdCount
public int getThresholdCount() -
getNestedConditions
-
accept
Description copied from interface:PathCondition
Returnstrue
if the specified candidate path should be deleted,false
otherwise.- Specified by:
accept
in interfacePathCondition
- Parameters:
basePath
- the directory from where to start scanning for deletion candidate filesrelativePath
- 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 interfacePathCondition
-
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
-