Package org.tinylog.policies

Class AbstractDatePolicy

java.lang.Object

org.tinylog.policies.AbstractDatePolicy

All Implemented Interfaces:

Policy

Direct Known Subclasses:

DailyPolicy, MonthlyPolicy

public abstract class AbstractDatePolicy
extends Object
implements Policy

Abstract base class for date based policies.

See Also:

DailyPolicy, MonthlyPolicy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDatePolicy(String name, String argument)

Method Summary

Modifier and Type	Method	Description
boolean	continueCurrentFile(byte[] entry)	Checks if a log entry can be appended to the current log file.
boolean	continueExistingFile(String path)	Checks if an existing log file can be continued.
void	reset()	Resets this policy as a new log file has been started.
protected abstract void	scrollAhead(Calendar calendar)	Scrolls a calendar ahead to the next policy epoch.
protected abstract void	scrollBack(Calendar calendar)	Scrolls a calendar back to the previous policy epoch.
protected abstract void	truncate(Calendar calendar, int hourOfDay, int minuteOfHour)	Truncates a calendar to the start of a policy epoch.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDatePolicy

protected AbstractDatePolicy(String name,
                             String argument)

Parameters:

name - Human-readable policy name that can be used in error messages

argument - Time for starting new log file (e.g. "23:30")

Throws:

IllegalArgumentException - Invalid time or zone passed in argument

Method Detail

continueExistingFile

public final boolean continueExistingFile(String path)

Description copied from interface: Policy

Checks if an existing log file can be continued.

Specified by:

continueExistingFile in interface Policy

Parameters:

path - Path to log file

Returns:

true if existing log file can be continued, false if a new log file should be created

continueCurrentFile

public final boolean continueCurrentFile(byte[] entry)

Description copied from interface: Policy

Checks if a log entry can be appended to the current log file.

Specified by:

continueCurrentFile in interface Policy

Parameters:

entry - Log entry

Returns:

true if log entry can be appended to the current log file, false if a new log file should be created

reset

public final void reset()

Description copied from interface: Policy

Resets this policy as a new log file has been started.

Specified by:

reset in interface Policy

truncate

protected abstract void truncate(Calendar calendar,
                                 int hourOfDay,
                                 int minuteOfHour)

Truncates a calendar to the start of a policy epoch. The start time can be defined by hour and minute.

Parameters:

calendar - Calendar to manipulate

hourOfDay - Start hour

minuteOfHour - Start minute of passed hour

scrollBack

protected abstract void scrollBack(Calendar calendar)

Scrolls a calendar back to the previous policy epoch.

Parameters:

calendar - Calendar to manipulate

scrollAhead

protected abstract void scrollAhead(Calendar calendar)

Scrolls a calendar ahead to the next policy epoch.

Parameters:

calendar - Calendar to manipulate