Package 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 Object
implements PathCondition

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

Since:

2.5

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IfLastModified.Builder

Field Summary

Fields

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

Fields inherited from interface org.apache.logging.log4j.core.appender.rolling.action.PathCondition

EMPTY_ARRAY

Constructor Summary

Constructors

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

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 IfLastModified	createAgeCondition(Duration age, PathCondition... pathConditions)	Deprecated. since 2.24.0 use newBuilder() instead.
Duration	getAge()	Deprecated. since 2.24.0.
List<PathCondition>	getNestedConditions()
static IfLastModified.Builder	newBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final Logger LOGGER

CLOCK

private static final Clock CLOCK

age

private final Duration age

nestedConditions

private final PathCondition[] nestedConditions

Constructor Details

IfLastModified

private IfLastModified(Duration age,
 PathCondition[] nestedConditions)

Method Details

getAge

@Deprecated
public Duration getAge()

Deprecated.

since 2.24.0. In 3.0.0 the signature will change.

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

createAgeCondition

@Deprecated
public static IfLastModified createAgeCondition(Duration age,
 PathCondition... pathConditions)

Deprecated.

since 2.24.0 use newBuilder() instead.

toString

public String toString()

Overrides:

toString in class Object

newBuilder

@PluginBuilderFactory
public static IfLastModified.Builder newBuilder()

Since:

2.24.0