Log4j 1.3alpha-7

org.apache.log4j.rolling
Interface TriggeringPolicy

All Superinterfaces:
OptionHandler
All Known Implementing Classes:
FilterBasedTriggeringPolicy, SizeBasedTriggeringPolicy, TimeBasedRollingPolicy

public interface TriggeringPolicy
extends OptionHandler

A TriggeringPolicy controls the conditions under which rollover occurs. Such conditions include time of day, file size, an external event, the log request or a combination thereof.

Since:
1.3
Author:
Ceki Gülcü, Curt Arnold

Method Summary
 boolean isTriggeringEvent(Appender appender, LoggingEvent event, String filename, long fileLength)
          Determines if a rollover may be appropriate at this time.
 
Methods inherited from interface org.apache.log4j.spi.OptionHandler
activateOptions
 

Method Detail

isTriggeringEvent

public boolean isTriggeringEvent(Appender appender,
                                 LoggingEvent event,
                                 String filename,
                                 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.

Parameters:
appender - A reference to the appender.
event - A reference to the currently event.
filename - The filename for the currently active log file.
fileLength - Length of the file in bytes.
Returns:
true if a rollover should occur.

Log4j 1.3alpha-7

Copyright 2000-2005 Apache Software Foundation.