Package org.pmw.tinylog.policies

Interface Policy

All Known Implementing Classes:

AbstractTimeBasedPolicy, CountPolicy, DailyPolicy, HourlyPolicy, MonthlyPolicy, SizePolicy, StartupPolicy, WeeklyPolicy, YearlyPolicy

public interface Policy

Policies define rollover strategies for RollingFileWriter.

The annotation PropertiesSupport must be added to the implemented policy class and the implemented policy must be registered as service in "META-INF/services/org.pmw.tinylog.policies" in order to make the policy available by properties files and system properties.

Example:
@PropertiesSupport(name = "startup")
public final class StartupPolicy implements Policy {

A policy must have a default constructor without any parameters. Optionally it can have an additional constructor with a string parameter if the policy supports parameters.

Method Summary

Modifier and Type	Method	Description
boolean	check(File logFile)	Determine whether a log file can be continued.
boolean	check(String logEntry)	Determine whether a log entry can be written into the current log file.
void	init(Configuration configuration)	Initialize the policy.
void	reset()	The log file was rolled and reset the policy.

Method Detail

init

void init(Configuration configuration)

Initialize the policy.

Parameters:

configuration - Configuration of logger

check

boolean check(File logFile)
       throws IOException

Determine whether a log file can be continued.

Parameters:

logFile - Log file to continue

Returns:

true to continue the log file, false to trigger a rollover

Throws:

IOException - Failed to handle log file

check

boolean check(String logEntry)

Determine whether a log entry can be written into the current log file.

Parameters:

logEntry - Log entry to write

Returns:

true to continue the current log file, false to trigger a rollover

reset

void reset()

The log file was rolled and reset the policy.