Package org.pmw.tinylog.writers

Class RollingFileWriter

java.lang.Object

org.pmw.tinylog.writers.RollingFileWriter

All Implemented Interfaces:

Writer

public final class RollingFileWriter
extends Object
implements Writer

Writes log entries to a file like FileWriter but keeps backups of old logging files.

Constructor Summary

Constructors

Constructor	Description
RollingFileWriter(String filename, int backups)	Rolling log files once at startup.
RollingFileWriter(String filename, int backups, boolean buffered)	Rolling log files once at startup.
RollingFileWriter(String filename, int backups, boolean buffered, Labeler labeler)	Rolling log files once at startup.
RollingFileWriter(String filename, int backups, boolean buffered, Labeler labeler, Policy... policies)
RollingFileWriter(String filename, int backups, boolean buffered, Policy... policies)
RollingFileWriter(String filename, int backups, Labeler labeler)	Rolling log files once at startup.
RollingFileWriter(String filename, int backups, Labeler labeler, Policy... policies)
RollingFileWriter(String filename, int backups, Policy... policies)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the log file.
void	flush()	Flush this writer and force any buffered data to output.
String	getFilename()	Get the filename of the current log file.
Labeler	getLabeler()	Get the labeler for naming backups.
int	getNumberOfBackups()	Get the maximum number of backups.
List<? extends Policy>	getPolicies()	Get the rollover strategies.
Set<LogEntryValue>	getRequiredLogEntryValues()	Get all log entry values that are required by this writer.
void	init(Configuration configuration)	Initialize the writer (open a file for example).
boolean	isBuffered()	Determine whether buffered writing is enabled.
void	write(LogEntry logEntry)	Write a log entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

RollingFileWriter

public RollingFileWriter(String filename,
                         int backups)

Rolling log files once at startup.

Parameters:

filename - Filename of the log file

backups - Number of backups

See Also:

StartupPolicy

RollingFileWriter

public RollingFileWriter(String filename,
                         int backups,
                         boolean buffered)

Rolling log files once at startup.

Parameters:

filename - Filename of the log file

backups - Number of backups

buffered - Buffered writing

See Also:

StartupPolicy

RollingFileWriter

public RollingFileWriter(String filename,
                         int backups,
                         Labeler labeler)

Rolling log files once at startup.

Parameters:

filename - Filename of the log file

backups - Number of backups

labeler - Labeler for naming backups

See Also:

StartupPolicy

RollingFileWriter

public RollingFileWriter(String filename,
                         int backups,
                         boolean buffered,
                         Labeler labeler)

Rolling log files once at startup.

Parameters:

filename - Filename of the log file

backups - Number of backups

buffered - Buffered writing

labeler - Labeler for naming backups

See Also:

StartupPolicy

RollingFileWriter

public RollingFileWriter(String filename,
                         int backups,
                         Policy... policies)

Parameters:

filename - Filename of the log file

backups - Number of backups

policies - Rollover strategies

RollingFileWriter

public RollingFileWriter(String filename,
                         int backups,
                         boolean buffered,
                         Policy... policies)

Parameters:

filename - Filename of the log file

backups - Number of backups

buffered - Buffered writing

policies - Rollover strategies

RollingFileWriter

public RollingFileWriter(String filename,
                         int backups,
                         Labeler labeler,
                         Policy... policies)

Parameters:

filename - Filename of the log file

backups - Number of backups

labeler - Labeler for naming backups

policies - Rollover strategies

RollingFileWriter

public RollingFileWriter(String filename,
                         int backups,
                         boolean buffered,
                         Labeler labeler,
                         Policy... policies)

Parameters:

filename - Filename of the log file

backups - Number of backups

buffered - Buffered writing

labeler - Labeler for naming backups

policies - Rollover strategies

Method Detail

getRequiredLogEntryValues

public Set<LogEntryValue> getRequiredLogEntryValues()

Description copied from interface: Writer

Get all log entry values that are required by this writer.

Specified by:

getRequiredLogEntryValues in interface Writer

Returns:

Required values for log entry

getFilename

public String getFilename()

Get the filename of the current log file.

Returns:

Filename of the current log file

isBuffered

public boolean isBuffered()

Determine whether buffered writing is enabled.

Returns:

true if buffered writing is enabled, otherwise false

getNumberOfBackups

public int getNumberOfBackups()

Get the maximum number of backups.

Returns:

Maximum number of backups

getLabeler

public Labeler getLabeler()

Get the labeler for naming backups.

Returns:

Labeler for naming backups

getPolicies

public List<? extends Policy> getPolicies()

Get the rollover strategies.

Returns:

Rollover strategies

init

public void init(Configuration configuration)
          throws IOException

Description copied from interface: Writer

Initialize the writer (open a file for example).

Specified by:

init in interface Writer

Parameters:

configuration - Configuration of logger

Throws:

IOException

write

public void write(LogEntry logEntry)
           throws IOException

Description copied from interface: Writer

Write a log entry.

Specified by:

write in interface Writer

Parameters:

logEntry - Log entry to output

Throws:

IOException

flush

public void flush()
           throws IOException

Description copied from interface: Writer

Flush this writer and force any buffered data to output.

Specified by:

flush in interface Writer

Throws:

IOException

close

public void close()
           throws IOException

Close the log file.

Specified by:

close in interface Writer

Throws:

IOException - Failed to close the log file