RollingPolicy

All Superinterfaces:

org.apache.log4j.spi.OptionHandler

All Known Implementing Classes:

FixedWindowRollingPolicy, RollingPolicyBase, TimeBasedRollingPolicy
```
public interface RollingPolicy
extends org.apache.log4j.spi.OptionHandler
```
A RollingPolicy specifies the actions taken on a logging file rollover.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`RolloverDescription`	`initialize(java.lang.String file, boolean append)`	Initialize the policy and return any initial actions for rolling file appender..
`RolloverDescription`	`rollover(java.lang.String activeFile)`	Prepare for a rollover.

Methods inherited from interface org.apache.log4j.spi.OptionHandler
activateOptions

- Method Detail
  - initialize
```
RolloverDescription initialize(java.lang.String file,
                               boolean append)
                        throws java.lang.SecurityException
```
    Initialize the policy and return any initial actions for rolling file appender..
    
    Parameters:
    
    file - current value of RollingFileAppender.getFile().
    
    append - current value of RollingFileAppender.getAppend().
    
    Returns:
    
    Description of the initialization, may be null to indicate no initialization needed.
    
    Throws:
    
    java.lang.SecurityException - if denied access to log files.
  - rollover
```
RolloverDescription rollover(java.lang.String activeFile)
                      throws java.lang.SecurityException
```
    Prepare for a rollover. This method is called prior to closing the active log file, performs any necessary preliminary actions and describes actions needed after close of current log file.
    
    Parameters:
    
    activeFile - file name for current active log file.
    
    Returns:
    
    Description of pending rollover, may be null to indicate no rollover at this time.
    
    Throws:
    
    java.lang.SecurityException - if denied access to log files.