Package org.apache.logging.log4j.core.appender.rolling

Class SizeBasedTriggeringPolicy

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.appender.rolling.AbstractTriggeringPolicy

org.apache.logging.log4j.core.appender.rolling.SizeBasedTriggeringPolicy

All Implemented Interfaces:

TriggeringPolicy, LifeCycle, LifeCycle2

@Plugin(name="SizeBasedTriggeringPolicy",
        category="Core",
        printObject=true)
public class SizeBasedTriggeringPolicy
extends AbstractTriggeringPolicy

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private RollingFileManager	manager
private static long	MAX_FILE_SIZE	Rollover threshold size in bytes.
private long	maxFileSize

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SizeBasedTriggeringPolicy()	Constructs a new instance.
protected	SizeBasedTriggeringPolicy(long maxFileSize)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
static SizeBasedTriggeringPolicy	createPolicy(java.lang.String size)	Create a SizeBasedTriggeringPolicy.
long	getMaxFileSize()
void	initialize(RollingFileManager aManager)	Initialize the TriggeringPolicy.
boolean	isTriggeringEvent(LogEvent event)	Returns true if a rollover should occur.
java.lang.String	toString()

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, start, stop, stop, stop

Methods inherited from class java.lang.Object

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

Field Detail

MAX_FILE_SIZE

private static final long MAX_FILE_SIZE

Rollover threshold size in bytes.

See Also:

Constant Field Values

maxFileSize

private final long maxFileSize

manager

private RollingFileManager manager

Constructor Detail

SizeBasedTriggeringPolicy

protected SizeBasedTriggeringPolicy()

Constructs a new instance.

SizeBasedTriggeringPolicy

protected SizeBasedTriggeringPolicy(long maxFileSize)

Constructs a new instance.

Parameters:

maxFileSize - rollover threshold size in bytes.

Method Detail

getMaxFileSize

public long getMaxFileSize()

initialize

public void initialize(RollingFileManager aManager)

Initialize the TriggeringPolicy.

Parameters:

aManager - The RollingFileManager.

isTriggeringEvent

public boolean isTriggeringEvent(LogEvent event)

Returns true if a rollover should occur.

Parameters:

event - A reference to the currently event.

Returns:

true if a rollover should take place, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createPolicy

@PluginFactory
public static SizeBasedTriggeringPolicy createPolicy(@PluginAttribute("size")
                                                     java.lang.String size)

Create a SizeBasedTriggeringPolicy.

Parameters:

size - The size of the file before rollover is required.

Returns:

A SizeBasedTriggeringPolicy.