Package org.apache.log4j.rolling
Class RollingPolicyBase
- java.lang.Object
-
- org.apache.log4j.rolling.RollingPolicyBase
-
- All Implemented Interfaces:
RollingPolicy
,org.apache.log4j.spi.OptionHandler
- Direct Known Subclasses:
FixedWindowRollingPolicy
,TimeBasedRollingPolicy
public abstract class RollingPolicyBase extends java.lang.Object implements RollingPolicy, org.apache.log4j.spi.OptionHandler
Implements methods common to most, it not all, rolling policies. Currently such methods are limited to a compression mode getter/setter.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
activeFileName
Active file name may be null.private java.lang.String
fileNamePatternStr
File name pattern.private static java.lang.String
FNP_NOT_SET
Error message.private org.apache.log4j.pattern.PatternConverter[]
patternConverters
File name pattern converters.private ExtrasFormattingInfo[]
patternFields
File name field specifiers.private static java.lang.String
SEE_FNP_NOT_SET
Reference for error message.
-
Constructor Summary
Constructors Constructor Description RollingPolicyBase()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
activateOptions()
protected void
formatFileName(java.lang.Object obj, java.lang.StringBuffer buf)
Format file name.java.lang.String
getActiveFileName()
Deprecated.Duplicates FileAppender.file and should be removedprotected org.apache.log4j.pattern.PatternConverter
getDatePatternConverter()
java.lang.String
getFileNamePattern()
Get file name pattern.protected org.apache.log4j.pattern.PatternConverter
getIntegerPatternConverter()
protected void
parseFileNamePattern()
Parse file name pattern.void
setActiveFileName(java.lang.String afn)
Deprecated.Duplicates FileAppender.file and should be removedvoid
setFileNamePattern(java.lang.String fnp)
Set file name pattern.-
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
-
FNP_NOT_SET
private static final java.lang.String FNP_NOT_SET
Error message.- See Also:
- Constant Field Values
-
SEE_FNP_NOT_SET
private static final java.lang.String SEE_FNP_NOT_SET
Reference for error message.- See Also:
- Constant Field Values
-
patternConverters
private org.apache.log4j.pattern.PatternConverter[] patternConverters
File name pattern converters.
-
patternFields
private ExtrasFormattingInfo[] patternFields
File name field specifiers.
-
fileNamePatternStr
private java.lang.String fileNamePatternStr
File name pattern.
-
activeFileName
protected java.lang.String activeFileName
Active file name may be null. Duplicates FileAppender.file and should be removed.
-
-
Method Detail
-
activateOptions
public void activateOptions()
- Specified by:
activateOptions
in interfaceorg.apache.log4j.spi.OptionHandler
-
setFileNamePattern
public void setFileNamePattern(java.lang.String fnp)
Set file name pattern.- Parameters:
fnp
- file name pattern.
-
getFileNamePattern
public java.lang.String getFileNamePattern()
Get file name pattern.- Returns:
- file name pattern.
-
setActiveFileName
public void setActiveFileName(java.lang.String afn)
Deprecated.Duplicates FileAppender.file and should be removedActiveFileName can be left unset, i.e. as null.- Parameters:
afn
- active file name.
-
getActiveFileName
public java.lang.String getActiveFileName()
Deprecated.Duplicates FileAppender.file and should be removedReturn the value of the ActiveFile option.- Returns:
- active file name.
-
parseFileNamePattern
protected final void parseFileNamePattern()
Parse file name pattern.
-
formatFileName
protected final void formatFileName(java.lang.Object obj, java.lang.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 org.apache.log4j.pattern.PatternConverter getDatePatternConverter()
-
getIntegerPatternConverter
protected final org.apache.log4j.pattern.PatternConverter getIntegerPatternConverter()
-
-