Module ch.qos.logback.core

Package ch.qos.logback.core.rolling

Class SizeAndTimeBasedFileNamingAndTriggeringPolicy<E>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

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

Type Parameters:

E -

All Implemented Interfaces:

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

Direct Known Subclasses:

SizeAndTimeBasedFNATP

public class SizeAndTimeBasedFileNamingAndTriggeringPolicy<E>
extends TimeBasedFileNamingAndTriggeringPolicyBase<E>

This class implement TimeBasedFileNamingAndTriggeringPolicy interface extending TimeBasedFileNamingAndTriggeringPolicyBase. This class is intended to be nested within a SizeAndTimeBasedFileNamingAndTriggeringPolicy instance. However, it can also be instantiated directly for testing purposes.

SizeAndTimeBasedFNATP class was renamed as SizeAndTimeBasedFileNamingAndTriggeringPolicy in version 1.5.8.

Since:

1.5.8

Author:

Ceki Gülcü

Field Summary

Fields

Modifier and Type	Field	Description
LengthCounter	lengthCounter

Fields inherited from class ch.qos.logback.core.rolling.TimeBasedFileNamingAndTriggeringPolicyBase

archiveRemover, artificialCurrentTime, atomicNextCheck, dateInCurrentPeriod, elapsedPeriodsFileName, errorFree, rc, started, tbrp, zoneId

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

context

Constructor Summary

Constructors

Constructor	Description
SizeAndTimeBasedFileNamingAndTriggeringPolicy()
SizeAndTimeBasedFileNamingAndTriggeringPolicy(ch.qos.logback.core.rolling.SizeAndTimeBasedFileNamingAndTriggeringPolicy.Usage usage)

Method Summary

Modifier and Type	Method	Description
protected ArchiveRemover	createArchiveRemover()
Duration	getCheckIncrement()
String	getCurrentPeriodsFileNameWithoutCompressionSuffix()	Return the current periods file name without the compression suffix.
LengthCounter	getLengthCounter()	Return the LengthCounter instance associated with this triggering policy.
boolean	isTriggeringEvent(File activeFile, E event)	Should roll-over be triggered at this time?
void	setCheckIncrement(Duration checkIncrement)
void	setMaxFileSize(FileSize aMaxFileSize)
void	start()

Methods inherited from class ch.qos.logback.core.rolling.TimeBasedFileNamingAndTriggeringPolicyBase

computeNextCheck, getArchiveRemover, getCurrentTime, getElapsedPeriodsFileName, isErrorFree, isStarted, setCurrentTime, setDateInCurrentPeriod, setTimeBasedRollingPolicy, stop, 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

Field Detail

lengthCounter

public LengthCounter lengthCounter

Constructor Detail

SizeAndTimeBasedFileNamingAndTriggeringPolicy

public SizeAndTimeBasedFileNamingAndTriggeringPolicy()

SizeAndTimeBasedFileNamingAndTriggeringPolicy

public SizeAndTimeBasedFileNamingAndTriggeringPolicy(ch.qos.logback.core.rolling.SizeAndTimeBasedFileNamingAndTriggeringPolicy.Usage usage)

Method Detail

start

public void start()

Specified by:

start in interface LifeCycle

Overrides:

start in class TimeBasedFileNamingAndTriggeringPolicyBase<E>

createArchiveRemover

protected ArchiveRemover createArchiveRemover()

isTriggeringEvent

public boolean isTriggeringEvent(File activeFile,
                                 E event)

Description copied from interface: TriggeringPolicy

Should roll-over be triggered at this time?

Parameters:

activeFile - A reference to the currently active log file.

event - A reference to the current event.

Returns:

true if a roll-over should occur.

getCheckIncrement

public Duration getCheckIncrement()

setCheckIncrement

public void setCheckIncrement(Duration checkIncrement)

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>

Overrides:

getCurrentPeriodsFileNameWithoutCompressionSuffix in class TimeBasedFileNamingAndTriggeringPolicyBase<E>

Returns:

current period's file name (without compression suffix)

setMaxFileSize

public void setMaxFileSize(FileSize aMaxFileSize)

getLengthCounter

public LengthCounter getLengthCounter()

Description copied from interface: TriggeringPolicy

Return the LengthCounter instance associated with this triggering policy. The returned value may be null.

Returns:

a LengthCounter instance, may be null