Package org.apache.log4j.rolling
Class SizeBasedTriggeringPolicy
java.lang.Object
org.apache.log4j.rolling.SizeBasedTriggeringPolicy
- All Implemented Interfaces:
TriggeringPolicy
,org.apache.log4j.spi.OptionHandler
public final class SizeBasedTriggeringPolicy
extends Object
implements TriggeringPolicy, org.apache.log4j.spi.OptionHandler
SizeBasedTriggeringPolicy looks at size of the file being
currently written to.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new instance.SizeBasedTriggeringPolicy
(long maxFileSize) Constructs an new instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Prepares policy for use.long
Gets rollover threshold size in bytes.boolean
isTriggeringEvent
(org.apache.log4j.Appender appender, org.apache.log4j.spi.LoggingEvent event, String file, long fileLength) Determines if a rollover may be appropriate at this time.void
setMaxFileSize
(long l) Sets rollover threshold size in bytes.
-
Field Details
-
maxFileSize
private long maxFileSizeRollover threshold size in bytes.
-
-
Constructor Details
-
SizeBasedTriggeringPolicy
public SizeBasedTriggeringPolicy()Constructs a new instance. -
SizeBasedTriggeringPolicy
public SizeBasedTriggeringPolicy(long maxFileSize) Constructs an new instance.- Parameters:
maxFileSize
- rollover threshold size in bytes.
-
-
Method Details
-
isTriggeringEvent
public boolean isTriggeringEvent(org.apache.log4j.Appender appender, org.apache.log4j.spi.LoggingEvent event, String file, long fileLength) Determines if a rollover may be appropriate at this time. If true is returned, RolloverPolicy.rollover will be called but it can determine that a rollover is not warranted.- Specified by:
isTriggeringEvent
in interfaceTriggeringPolicy
- Parameters:
appender
- A reference to the appender.event
- A reference to the currently event.file
- The filename for the currently active log file.fileLength
- Length of the file in bytes.- Returns:
- true if a rollover should occur.
-
getMaxFileSize
public long getMaxFileSize()Gets rollover threshold size in bytes.- Returns:
- rollover threshold size in bytes.
-
setMaxFileSize
public void setMaxFileSize(long l) Sets rollover threshold size in bytes.- Parameters:
l
- new value for rollover threshold size.
-
activateOptions
public void activateOptions()Prepares policy for use.- Specified by:
activateOptions
in interfaceorg.apache.log4j.spi.OptionHandler
-