Package org.pmw.tinylog.labelers

Class TimestampLabeler

java.lang.Object

org.pmw.tinylog.labelers.TimestampLabeler

All Implemented Interfaces:

Labeler

public final class TimestampLabeler
extends Object
implements Labeler

Adds a timestamp to the real log file and the backups.

Constructor Summary

Constructors

Constructor	Description
TimestampLabeler()	Use the default timestamp: yyyy-MM-dd HH-mm-ss.
TimestampLabeler(String pattern)	Timestamp pattern is compatible with SimpleDateFormat(String).

Method Summary

Modifier and Type	Method	Description
File	getLogFile(File baseFile, int maxBackups)	Returns the real log file.
void	init(Configuration configuration)	Initialize the labeler.
File	roll(File file, int maxBackups)	Rolls existing log files and backups and returns a new log file.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimestampLabeler

public TimestampLabeler()

Use the default timestamp: yyyy-MM-dd HH-mm-ss.

TimestampLabeler

public TimestampLabeler(String pattern)

Timestamp pattern is compatible with SimpleDateFormat(String).

Parameters:

pattern - Timestamp pattern for formatting the time-based identify

Method Detail

init

public void init(Configuration configuration)

Description copied from interface: Labeler

Initialize the labeler.

Specified by:

init in interface Labeler

Parameters:

configuration - Configuration of logger

getLogFile

public File getLogFile(File baseFile,
                       int maxBackups)

Description copied from interface: Labeler

Returns the real log file.

Specified by:

getLogFile in interface Labeler

Parameters:

baseFile - Defined log file by user

maxBackups - Maximum number of backups to store

Returns:

Real log file

roll

public File roll(File file,
                 int maxBackups)

Description copied from interface: Labeler

Rolls existing log files and backups and returns a new log file.

Specified by:

roll in interface Labeler

Parameters:

file - Current log file

maxBackups - Maximum number of backups to store

Returns:

New log file