Package org.pmw.tinylog.policies

Class CountPolicy

java.lang.Object

org.pmw.tinylog.policies.CountPolicy

All Implemented Interfaces:

Policy

public final class CountPolicy
extends Object
implements Policy

Policy for limiting the number of log entries per file.

Constructor Summary

Constructors

Constructor	Description
CountPolicy(long limit)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CountPolicy

public CountPolicy(long limit)
            throws IllegalArgumentException

Parameters:

limit - Maximum number of log entries per file (must be > 0)

Throws:

IllegalArgumentException - if limit is <= 0

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 boolean check(File logFile)
              throws IOException

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

Throws:

IOException - Failed to handle log file

check

public 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 void reset()

Description copied from interface: Policy

The log file was rolled and reset the policy.

Specified by:

reset in interface Policy