- All Superinterfaces:
LifeCycle
- All Known Implementing Classes:
FixedWindowRollingPolicy
,RollingPolicyBase
,SizeAndTimeBasedRollingPolicy
,TimeBasedRollingPolicy
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.- Author:
- Ceki Gülcü
-
Method Summary
Modifier and TypeMethodDescriptionGet the name of the active log file.The compression mode for this policy.void
rollover()
Rolls over log files according to implementation policy.void
setParent
(FileAppender<?> appender) This method allows RollingPolicy implementations to be aware of their containing appender.
-
Method Details
-
rollover
Rolls over log files according to implementation policy.This method is invoked by
RollingFileAppender
, usually at the behest of itsTriggeringPolicy
.- Throws:
RolloverFailure
- Thrown if the rollover operation fails for any reason.
-
getActiveFileName
Get the name of the active log file.With implementations such as
TimeBasedRollingPolicy
, this method returns a new file name, where the actual output will be sent.On other implementations, this method might return the FileAppender's file property.
-
getCompressionMode
The compression mode for this policy.- Returns:
-
setParent
This method allows RollingPolicy implementations to be aware of their containing appender.- Parameters:
appender
-
-