Module ch.qos.logback.core

Package ch.qos.logback.core.rolling

Class TimeBasedFileNamingAndTriggeringPolicyBase<E>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.rolling.TimeBasedFileNamingAndTriggeringPolicyBase<E>

Type Parameters:

E -

All Implemented Interfaces:

TimeBasedFileNamingAndTriggeringPolicy<E>, TriggeringPolicy<E>, ContextAware, LifeCycle

Direct Known Subclasses:

DefaultTimeBasedFileNamingAndTriggeringPolicy, SizeAndTimeBasedFileNamingAndTriggeringPolicy

public abstract class TimeBasedFileNamingAndTriggeringPolicyBase<E>
extends ContextAwareBase
implements TimeBasedFileNamingAndTriggeringPolicy<E>

Base implementation of TimeBasedFileNamingAndTriggeringPolicy.

See also derived classes DefaultTimeBasedFileNamingAndTriggeringPolicy and SizeAndTimeBasedFileNamingAndTriggeringPolicy.

Field Summary

Fields

Modifier and Type	Field	Description
protected ArchiveRemover	archiveRemover
protected long	artificialCurrentTime
protected AtomicLong	atomicNextCheck
protected Instant	dateInCurrentPeriod
protected String	elapsedPeriodsFileName
protected boolean	errorFree
protected RollingCalendar	rc
protected boolean	started
protected TimeBasedRollingPolicy<E>	tbrp

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
TimeBasedFileNamingAndTriggeringPolicyBase()

Method Summary

Modifier and Type	Method	Description
protected long	computeNextCheck(long timestamp)
ArchiveRemover	getArchiveRemover()	Return the archive remover appropriate for this instance.
String	getCurrentPeriodsFileNameWithoutCompressionSuffix()	Return the current periods file name without the compression suffix.
long	getCurrentTime()	Return the current time which is usually the value returned by System.currentMillis().
String	getElapsedPeriodsFileName()	Return the file name for the elapsed periods file name.
protected boolean	isErrorFree()
boolean	isStarted()
void	setCurrentTime(long timeInMillis)	Set the current time.
protected void	setDateInCurrentPeriod(long timestamp)
void	setTimeBasedRollingPolicy(TimeBasedRollingPolicy<E> _tbrp)	Set the host/parent TimeBasedRollingPolicy.
void	start()
void	stop()
protected void	withErrors()

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Methods inherited from interface ch.qos.logback.core.rolling.TriggeringPolicy

getLengthCounter, isTriggeringEvent

Field Details

tbrp

protected TimeBasedRollingPolicy<E> tbrp

archiveRemover

protected ArchiveRemover archiveRemover

elapsedPeriodsFileName

protected String elapsedPeriodsFileName

rc

protected RollingCalendar rc

artificialCurrentTime

protected long artificialCurrentTime

atomicNextCheck

protected AtomicLong atomicNextCheck

dateInCurrentPeriod

protected Instant dateInCurrentPeriod

started

protected boolean started

errorFree

protected boolean errorFree

Constructor Details

TimeBasedFileNamingAndTriggeringPolicyBase

public TimeBasedFileNamingAndTriggeringPolicyBase()

Method Details

isStarted

public boolean isStarted()

Specified by:

isStarted in interface LifeCycle

start

public void start()

Specified by:

start in interface LifeCycle

stop

public void stop()

Specified by:

stop in interface LifeCycle

computeNextCheck

protected long computeNextCheck(long timestamp)

getElapsedPeriodsFileName

public String getElapsedPeriodsFileName()

Description copied from interface: TimeBasedFileNamingAndTriggeringPolicy

Return the file name for the elapsed periods file name.

Specified by:

getElapsedPeriodsFileName in interface TimeBasedFileNamingAndTriggeringPolicy<E>

Returns:

getCurrentPeriodsFileNameWithoutCompressionSuffix

public String getCurrentPeriodsFileNameWithoutCompressionSuffix()

Description copied from interface: TimeBasedFileNamingAndTriggeringPolicy

Return the current periods file name without the compression suffix. This value is equivalent to the active file name.

Specified by:

getCurrentPeriodsFileNameWithoutCompressionSuffix in interface TimeBasedFileNamingAndTriggeringPolicy<E>

Returns:

current period's file name (without compression suffix)

setDateInCurrentPeriod

protected void setDateInCurrentPeriod(long timestamp)

setCurrentTime

public void setCurrentTime(long timeInMillis)

Description copied from interface: TimeBasedFileNamingAndTriggeringPolicy

Set the current time. Only unit tests should invoke this method.

Specified by:

setCurrentTime in interface TimeBasedFileNamingAndTriggeringPolicy<E>

Parameters:

timeInMillis -

getCurrentTime

public long getCurrentTime()

Description copied from interface: TimeBasedFileNamingAndTriggeringPolicy

Return the current time which is usually the value returned by System.currentMillis(). However, for testing purposed this value may be different than the real time.

Specified by:

getCurrentTime in interface TimeBasedFileNamingAndTriggeringPolicy<E>

Returns:

current time value

setTimeBasedRollingPolicy

public void setTimeBasedRollingPolicy(TimeBasedRollingPolicy<E> _tbrp)

Description copied from interface: TimeBasedFileNamingAndTriggeringPolicy

Set the host/parent TimeBasedRollingPolicy.

Specified by:

setTimeBasedRollingPolicy in interface TimeBasedFileNamingAndTriggeringPolicy<E>

Parameters:

_tbrp - parent TimeBasedRollingPolicy

getArchiveRemover

public ArchiveRemover getArchiveRemover()

Description copied from interface: TimeBasedFileNamingAndTriggeringPolicy

Return the archive remover appropriate for this instance.

Specified by:

getArchiveRemover in interface TimeBasedFileNamingAndTriggeringPolicy<E>

withErrors

protected void withErrors()

isErrorFree

protected boolean isErrorFree()