Package org.pmw.tinylog.policies

Class SizePolicy

java.lang.Object

org.pmw.tinylog.policies.SizePolicy

All Implemented Interfaces:

Policy

public final class SizePolicy
extends Object
implements Policy

Policy for limiting the size of log files.

Constructor Summary

Constructors

Constructor	Description
SizePolicy(long maxSize)

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

SizePolicy

public SizePolicy(long maxSize)
           throws IllegalArgumentException

Parameters:

maxSize - Maximum size of a log file in bytes (must be > 0)

Throws:

IllegalArgumentException - if maxSize 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)

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 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