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>
-
- All Implemented Interfaces:
TimeBasedFileNamingAndTriggeringPolicy<E>
,TriggeringPolicy<E>
,ContextAware
,LifeCycle
- Direct Known Subclasses:
DefaultTimeBasedFileNamingAndTriggeringPolicy
,SizeAndTimeBasedFNATP
public abstract class TimeBasedFileNamingAndTriggeringPolicyBase<E> extends ContextAwareBase implements TimeBasedFileNamingAndTriggeringPolicy<E>
-
-
Field Summary
Fields Modifier and Type Field Description protected ArchiveRemover
archiveRemover
protected long
artificialCurrentTime
protected java.util.Date
dateInCurrentPeriod
protected java.lang.String
elapsedPeriodsFileName
protected boolean
errorFree
protected long
nextCheck
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
computeNextCheck()
ArchiveRemover
getArchiveRemover()
Return the archive remover appropriate for this instance.java.lang.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().java.lang.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 now)
void
setDateInCurrentPeriod(java.util.Date _dateInCurrentPeriod)
void
setTimeBasedRollingPolicy(TimeBasedRollingPolicy<E> _tbrp)
Set the host/parentTimeBasedRollingPolicy
.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
isTriggeringEvent
-
-
-
-
Field Detail
-
tbrp
protected TimeBasedRollingPolicy<E> tbrp
-
archiveRemover
protected ArchiveRemover archiveRemover
-
elapsedPeriodsFileName
protected java.lang.String elapsedPeriodsFileName
-
rc
protected RollingCalendar rc
-
artificialCurrentTime
protected long artificialCurrentTime
-
dateInCurrentPeriod
protected java.util.Date dateInCurrentPeriod
-
nextCheck
protected long nextCheck
-
started
protected boolean started
-
errorFree
protected boolean errorFree
-
-
Method Detail
-
computeNextCheck
protected void computeNextCheck()
-
setDateInCurrentPeriod
protected void setDateInCurrentPeriod(long now)
-
setDateInCurrentPeriod
public void setDateInCurrentPeriod(java.util.Date _dateInCurrentPeriod)
-
getElapsedPeriodsFileName
public java.lang.String getElapsedPeriodsFileName()
Description copied from interface:TimeBasedFileNamingAndTriggeringPolicy
Return the file name for the elapsed periods file name.- Specified by:
getElapsedPeriodsFileName
in interfaceTimeBasedFileNamingAndTriggeringPolicy<E>
- Returns:
-
getCurrentPeriodsFileNameWithoutCompressionSuffix
public java.lang.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 interfaceTimeBasedFileNamingAndTriggeringPolicy<E>
- Returns:
- current period's file name (without compression suffix)
-
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 interfaceTimeBasedFileNamingAndTriggeringPolicy<E>
-
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 interfaceTimeBasedFileNamingAndTriggeringPolicy<E>
- Returns:
- current time value
-
setTimeBasedRollingPolicy
public void setTimeBasedRollingPolicy(TimeBasedRollingPolicy<E> _tbrp)
Description copied from interface:TimeBasedFileNamingAndTriggeringPolicy
Set the host/parentTimeBasedRollingPolicy
.- Specified by:
setTimeBasedRollingPolicy
in interfaceTimeBasedFileNamingAndTriggeringPolicy<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 interfaceTimeBasedFileNamingAndTriggeringPolicy<E>
-
withErrors
protected void withErrors()
-
isErrorFree
protected boolean isErrorFree()
-
-