Package org.pmw.tinylog.labelers

Interface Labeler

All Known Implementing Classes:

CountLabeler, ProcessIdLabeler, TimestampLabeler

public interface Labeler

A labeler names log files and backups for RollingFileWriter.

The annotation PropertiesSupport must be added to the implemented labeler class and the implemented labeler must be registered as service in "META-INF/services/org.pmw.tinylog.labelers" in order to make the labeler available by properties files and system properties.

Example:
@PropertiesSupport(name = "count")
public final class CountLabeler implements Labeler {

A labeler must have a default constructor without any parameters. Optionally it can have an additional constructor with a string parameter if the labeler supports parameters.

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.

Method Detail

init

void init(Configuration configuration)

Initialize the labeler.

Parameters:

configuration - Configuration of logger

getLogFile

File getLogFile(File baseFile,
                int maxBackups)

Returns the real log file.

Parameters:

baseFile - Defined log file by user

maxBackups - Maximum number of backups to store

Returns:

Real log file

roll

File roll(File file,
          int maxBackups)
   throws IOException

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

Parameters:

file - Current log file

maxBackups - Maximum number of backups to store

Returns:

New log file

Throws:

IOException - Failed to roll log file