Log4j 1.3alpha-7

org.apache.log4j.rolling
Class RollingPolicyBase

java.lang.Object
  extended byorg.apache.log4j.spi.ComponentBase
      extended byorg.apache.log4j.rolling.RollingPolicyBase
All Implemented Interfaces:
Component, OptionHandler, RollingPolicy
Direct Known Subclasses:
FixedWindowRollingPolicy, TimeBasedRollingPolicy

public abstract class RollingPolicyBase
extends ComponentBase
implements RollingPolicy, OptionHandler

Implements methods common to most, it not all, rolling policies. Currently such methods are limited to a compression mode getter/setter.

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

Field Summary
protected  String activeFileName
          Active file name may be null.
 
Fields inherited from class org.apache.log4j.spi.ComponentBase
repository
 
Constructor Summary
RollingPolicyBase()
           
 
Method Summary
 void activateOptions()
          Activate the options that were previously set with calls to option setters.

This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.

For example, the FileAppender has the File and Append options both of which are ambigous until the other is also set.

protected  void formatFileName(Object obj, StringBuffer buf)
          Format file name.
 String getActiveFileName()
          Deprecated. Duplicates FileAppender.file and should be removed
protected  PatternConverter getDatePatternConverter()
           
 String getFileNamePattern()
          Get file name pattern.
protected  PatternConverter getIntegerPatternConverter()
           
protected  void parseFileNamePattern()
          Parse file name pattern.
 void setActiveFileName(String afn)
          Deprecated. Duplicates FileAppender.file and should be removed
 void setFileNamePattern(String fnp)
          Set file name pattern.
 
Methods inherited from class org.apache.log4j.spi.ComponentBase
getLogger, getLoggerRepository, getNonFloodingLogger, resetErrorCount, setLoggerRepository
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.log4j.rolling.RollingPolicy
initialize, rollover
 

Field Detail

activeFileName

protected String activeFileName
Active file name may be null. Duplicates FileAppender.file and should be removed.

Constructor Detail

RollingPolicyBase

public RollingPolicyBase()
Method Detail

activateOptions

public void activateOptions()
Activate the options that were previously set with calls to option setters.

This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.

For example, the FileAppender has the File and Append options both of which are ambigous until the other is also set.

Specified by:
activateOptions in interface OptionHandler

setFileNamePattern

public void setFileNamePattern(String fnp)
Set file name pattern.

Parameters:
fnp - file name pattern.

getFileNamePattern

public String getFileNamePattern()
Get file name pattern.

Returns:
file name pattern.

setActiveFileName

public void setActiveFileName(String afn)
Deprecated. Duplicates FileAppender.file and should be removed

ActiveFileName can be left unset, i.e. as null.

Parameters:
afn - active file name.

getActiveFileName

public String getActiveFileName()
Deprecated. Duplicates FileAppender.file and should be removed

Return the value of the ActiveFile option.

Returns:
active file name.

parseFileNamePattern

protected final void parseFileNamePattern()
Parse file name pattern.


formatFileName

protected final void formatFileName(Object obj,
                                    StringBuffer buf)
Format file name.

Parameters:
obj - object to be evaluted in formatting, may not be null.
buf - string buffer to which formatted file name is appended, may not be null.

getDatePatternConverter

protected final PatternConverter getDatePatternConverter()

getIntegerPatternConverter

protected final PatternConverter getIntegerPatternConverter()

Log4j 1.3alpha-7

Copyright 2000-2005 Apache Software Foundation.