Package org.pmw.tinylog.policies

Class AbstractTimeBasedPolicy

java.lang.Object

org.pmw.tinylog.policies.AbstractTimeBasedPolicy

All Implemented Interfaces:

Policy

Direct Known Subclasses:

DailyPolicy, HourlyPolicy, MonthlyPolicy, WeeklyPolicy, YearlyPolicy

public abstract class AbstractTimeBasedPolicy
extends Object
implements Policy

Base class for time based policies.

Constructor Summary

Constructors

Constructor	Description
AbstractTimeBasedPolicy(Calendar calendar, int field)

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.
protected static void	normalize(Calendar calendar, int field)	Make sure that the time is in future.
void	reset()	The log file was rolled and reset the policy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractTimeBasedPolicy

public AbstractTimeBasedPolicy(Calendar calendar,
                               int field)

Parameters:

calendar - Time for next rollover

field - Field (e.g. Calendar.HOUR_OF_DAY) to increase after a rollover

Method Detail

init

public void init(Configuration configuration)

Description copied from interface: Policy

Initialize the policy.

Specified by:

init in interface Policy

Parameters:

configuration - Configuration of logger

check

public final boolean check(File logFile)

Description copied from interface: Policy

Determine whether a log file can be continued.

Specified by:

check in interface Policy

Parameters:

logFile - Log file to continue

Returns:

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

check

public final boolean check(String logEntry)

Description copied from interface: Policy

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

Specified by:

check in interface Policy

Parameters:

logEntry - Log entry to write

Returns:

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

reset

public final void reset()

Description copied from interface: Policy

The log file was rolled and reset the policy.

Specified by:

reset in interface Policy

normalize

protected static void normalize(Calendar calendar,
                                int field)

Make sure that the time is in future.

Parameters:

calendar - Calendar to normalize

field - Field (e.g. Calendar.HOUR_OF_DAY) to increase