Top Inners Fields Constructors Methods

ch.qos.logback.core.rolling.helper

public Class TimeBasedArchiveRemover

Class Inheritance

extends ContextAwareBase
implements ArchiveRemover

java.lang.Object
ch.qos.logback.core.spi.ContextAwareBase
ch.qos.logback.core.rolling.helper.TimeBasedArchiveRemover

All Implemented Interfaces

ch.qos.logback.core.rolling.helper.ArchiveRemover, ch.qos.logback.core.spi.ContextAware

Known Direct Subclasses

ch.qos.logback.core.rolling.helper.SizeAndTimeBasedArchiveRemover

Static Imports

ch.qos.logback.core.CoreConstants.UNBOUNDED_TOTAL_SIZE_CAP

Nested and Inner Type Summary

Modifier and Type	Class and Description
public class	TimeBasedArchiveRemover.ArchiveRemoverRunnable

Field Summary

Modifier and Type	Field and Description
pack-priv int	callCount
pack-priv final FileNamePattern	fileNamePattern
protected static final long	INACTIVITY_TOLERANCE_IN_MILLIS
pack-priv long	lastHeartBeat
pack-priv static final int	MAX_VALUE_FOR_INACTIVITY_PERIODS
private int	maxHistory
pack-priv final boolean	parentClean
pack-priv final RollingCalendar	rc
private long	totalSizeCap
protected static final long	UNINITIALIZED

Inherited from ch.qos.logback.core.spi.ContextAwareBase:: context

Constructor Summary

Access	Constructor and Description
public	TimeBasedArchiveRemover(FileNamePattern fileNamePattern, RollingCalendar rc)

Method Summary

Modifier and Type	Method and Description
pack-priv void	capTotalSize(Instant now)
private boolean	checkAndDeleteFile(File f)
public void	clean(Instant now) Implements ch.qos.logback.core.rolling.helper.ArchiveRemover.clean. Called from the cleaning thread.
public Future<?>	cleanAsynchronously(Instant now) Implements ch.qos.logback.core.rolling.helper.ArchiveRemover.cleanAsynchronously.
public void	cleanPeriod(Instant instantOfPeriodToClean)
pack-priv int	computeElapsedPeriodsSinceLastClean(long nowInMillis)
pack-priv boolean	computeParentCleaningFlag(FileNamePattern fileNamePattern) Computes whether the fileNamePattern may create sub-folders.
protected void	descendingSort(File[] matchingFileArray, Instant instant)
private boolean	fileExistsAndIsFile(File file2Delete)
protected File[]	getFilesInPeriod(Instant instantOfPeriodToClean)
pack-priv File	getParentDir(File file)
protected int	getPeriodOffsetForDeletionTarget()
pack-priv void	removeFolderIfEmpty(File dir)
private void	removeFolderIfEmpty(File dir, int depth) Will remove the directory passed as parameter if empty.
public void	setMaxHistory(int maxHistory) Implements ch.qos.logback.core.rolling.helper.ArchiveRemover.setMaxHistory.
public void	setTotalSizeCap(long totalSizeCap) Implements ch.qos.logback.core.rolling.helper.ArchiveRemover.setTotalSizeCap.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from ch.qos.logback.core.spi.ContextAwareBase:: addError addError addInfo addInfo addStatus addWarn addWarn getContext getDeclaredOrigin getStatusManager setContext

Field Detail

callCount	back to summary
pack-priv int callCount

fileNamePattern	back to summary
pack-priv final FileNamePattern fileNamePattern

INACTIVITY_TOLERANCE_IN_MILLIS	back to summary
protected static final long INACTIVITY_TOLERANCE_IN_MILLIS

lastHeartBeat	back to summary
pack-priv long lastHeartBeat

MAX_VALUE_FOR_INACTIVITY_PERIODS	back to summary
pack-priv static final int MAX_VALUE_FOR_INACTIVITY_PERIODS

maxHistory	back to summary
private int maxHistory

parentClean	back to summary
pack-priv final boolean parentClean

rc	back to summary
pack-priv final RollingCalendar rc

totalSizeCap	back to summary
private long totalSizeCap

UNINITIALIZED	back to summary
protected static final long UNINITIALIZED

Constructor Detail

TimeBasedArchiveRemover	back to summary
public TimeBasedArchiveRemover(FileNamePattern fileNamePattern, RollingCalendar rc)

Method Detail

capTotalSize	back to summary
pack-priv void capTotalSize(Instant now)

checkAndDeleteFile	back to summary
private boolean checkAndDeleteFile(File f)

clean

back to summary

public void clean(Instant now)

Implements ch.qos.logback.core.rolling.helper.ArchiveRemover.clean.

Called from the cleaning thread.

Annotations

@Override

cleanAsynchronously	back to summary
public Future<?> cleanAsynchronously(Instant now) Implements ch.qos.logback.core.rolling.helper.ArchiveRemover.cleanAsynchronously.

cleanPeriod	back to summary
public void cleanPeriod(Instant instantOfPeriodToClean)

computeElapsedPeriodsSinceLastClean	back to summary
pack-priv int computeElapsedPeriodsSinceLastClean(long nowInMillis)

computeParentCleaningFlag	back to summary
pack-priv boolean computeParentCleaningFlag(FileNamePattern fileNamePattern) Computes whether the fileNamePattern may create sub-folders.

descendingSort	back to summary
protected void descendingSort(File[] matchingFileArray, Instant instant)

fileExistsAndIsFile	back to summary
private boolean fileExistsAndIsFile(File file2Delete)

getFilesInPeriod	back to summary
protected File[] getFilesInPeriod(Instant instantOfPeriodToClean)

getParentDir	back to summary
pack-priv File getParentDir(File file)

getPeriodOffsetForDeletionTarget	back to summary
protected int getPeriodOffsetForDeletionTarget()

removeFolderIfEmpty	back to summary
pack-priv void removeFolderIfEmpty(File dir)

removeFolderIfEmpty	back to summary
private void removeFolderIfEmpty(File dir, int depth) Will remove the directory passed as parameter if empty. After that, if the parent is also becomes empty, remove the parent dir as well but at most 3 times.

setMaxHistory	back to summary
public void setMaxHistory(int maxHistory) Implements ch.qos.logback.core.rolling.helper.ArchiveRemover.setMaxHistory.

setTotalSizeCap	back to summary
public void setTotalSizeCap(long totalSizeCap) Implements ch.qos.logback.core.rolling.helper.ArchiveRemover.setTotalSizeCap.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object.

ch.qos.logback.core.rolling.helper back to summary

public Class TimeBasedArchiveRemover.ArchiveRemoverRunnable

Class Inheritance

extends Object
implements Runnable

java.lang.Object
ch.qos.logback.core.rolling.helper.TimeBasedArchiveRemover.ArchiveRemoverRunnable

All Implemented Interfaces

java.lang.Runnable

Field Summary

Modifier and Type	Field and Description
pack-priv Instant	now

Constructor Summary

Access	Constructor and Description
pack-priv	ArchiveRemoverRunnable(Instant now)

Method Summary

Modifier and Type	Method and Description
public void	run() Implements java.lang.Runnable.run. Runs this operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

now	back to summary
pack-priv Instant now

Constructor Detail

ArchiveRemoverRunnable	back to summary
pack-priv ArchiveRemoverRunnable(Instant now)

Method Detail

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override