Log4j 1.3alpha-6

org.apache.log4j.rolling
Interface RollingPolicy

All Superinterfaces:
OptionHandler
All Known Implementing Classes:
RollingPolicyBase

public interface RollingPolicy
extends OptionHandler

A RollingPolicy is responsible for performing the rolling over of the active log file. The RollingPolicy is also responsible for providing the active log file, that is the live file where logging output will be directed.

Since:
1.3
Author:
Ceki Gülcü

Method Summary
 java.lang.String getActiveFileName()
          Get the new name of the active log file.
 void rollover()
          Rolls over log files according to implementation policy.
 
Methods inherited from interface org.apache.log4j.spi.OptionHandler
activateOptions
 

Method Detail

rollover

public void rollover()
              throws RolloverFailure
Rolls over log files according to implementation policy.

This method is invoked by RollingFileAppender, usually at the behest of its TriggeringPolicy.

Throws:
RolloverFailure - Thrown if the rollover operation fails for any reason.

getActiveFileName

public java.lang.String getActiveFileName()
Get the new name of the active log file.


Log4j 1.3alpha-6

Copyright 2000-2005 Apache Software Foundation.