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

Class IfLastModified

java.lang.Object

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

All Implemented Interfaces:

PathCondition

@Plugin(name="IfLastModified",
        category="Core",
        printObject=true)
public final class IfLastModified
extends java.lang.Object
implements PathCondition

PathCondition that accepts paths that are older than the specified duration.

Field Summary

Fields

Modifier and Type	Field and Description
private Duration	age
private static Clock	CLOCK
private static Logger	LOGGER
private PathCondition[]	nestedConditions

Constructor Summary

Constructors

Modifier	Constructor and Description
private	IfLastModified(Duration age, PathCondition[] nestedConditions)

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.nio.file.Path basePath, java.nio.file.Path relativePath, java.nio.file.attribute.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 IfLastModified	createAgeCondition(Duration age, PathCondition... nestedConditions) Create an IfLastModified condition.
Duration	getAge()
java.util.List<PathCondition>	getNestedConditions()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final Logger LOGGER

CLOCK

private static final Clock CLOCK

age

private final Duration age

nestedConditions

private final PathCondition[] nestedConditions

Constructor Detail

IfLastModified

private IfLastModified(Duration age,
                       PathCondition[] nestedConditions)

Method Detail

getAge

public Duration getAge()

getNestedConditions

public java.util.List<PathCondition> getNestedConditions()

accept

public boolean accept(java.nio.file.Path basePath,
                      java.nio.file.Path relativePath,
                      java.nio.file.attribute.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

createAgeCondition

@PluginFactory
public static IfLastModified createAgeCondition(@PluginAttribute(value="age")
                                                               Duration age,
                                                               @PluginElement(value="PathConditions")
                                                               PathCondition... nestedConditions)

Create an IfLastModified condition.

Parameters:

age - The path age that is accepted by this condition. Must be a valid Duration.

nestedConditions - nested conditions to evaluate if this condition accepts a path

Returns:

An IfLastModified condition.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object