Module ch.qos.logback.core

Package ch.qos.logback.core.rolling

Class SizeBasedTriggeringPolicy<E>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

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

All Implemented Interfaces:

TriggeringPolicy<E>, ContextAware, LifeCycle

public class SizeBasedTriggeringPolicy<E>
extends TriggeringPolicyBase<E>

SizeBasedTriggeringPolicy looks at size of the file being currently written to. If it grows bigger than the specified size, the FileAppender using the SizeBasedTriggeringPolicy rolls the file and creates a new one. For more information about this policy, please refer to the online manual at http://logback.qos.ch/manual/appenders.html#SizeBasedTriggeringPolicy

Author:

Ceki Gülcü

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_MAX_FILE_SIZE	The default maximum file size.
static final String	SEE_SIZE_FORMAT

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

context

Constructor Summary

Constructors

Constructor	Description
SizeBasedTriggeringPolicy()

Method Summary

Modifier and Type	Method	Description
Duration	getCheckIncrement()
FileSize	getMaxFileSize()
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.TriggeringPolicyBase

isStarted, stop

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

Field Details

SEE_SIZE_FORMAT

public static final String SEE_SIZE_FORMAT

See Also:

• Constant Field Values

DEFAULT_MAX_FILE_SIZE

public static final long DEFAULT_MAX_FILE_SIZE

The default maximum file size.

See Also:

• Constant Field Values

Constructor Details

SizeBasedTriggeringPolicy

public SizeBasedTriggeringPolicy()

Method Details

start

public void start()

Specified by:

start in interface LifeCycle

Overrides:

start in class TriggeringPolicyBase<E>

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.

getMaxFileSize

public FileSize getMaxFileSize()

setMaxFileSize

public void setMaxFileSize(FileSize aMaxFileSize)

getCheckIncrement

public Duration getCheckIncrement()

setCheckIncrement

public void setCheckIncrement(Duration checkIncrement)