Package org.tinylog.converters

Class GzipFileConverter

java.lang.Object

org.tinylog.converters.GzipFileConverter

All Implemented Interfaces:

FileConverter

public final class GzipFileConverter
extends Object
implements FileConverter

Converter for compressing a log file asynchronously by the GZIP algorithm when backing up the file.

Constructor Summary

Constructors

Constructor	Description
GzipFileConverter()

Method Summary

Modifier and Type	Method	Description
void	close()	This method is called when tinylog closes the current log file.
String	getBackupSuffix()	Gets the additional file extension for backup files.
void	open(String fileName)	This method is called when tinylog opens a log file for writing log entries.
void	shutdown()	Shuts this file converter down.
byte[]	write(byte[] data)	This method can convert data before writing to the currently opened log file.

Methods inherited from class java.lang.Object

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

Constructor Detail

GzipFileConverter

public GzipFileConverter()

Method Detail

getBackupSuffix

public String getBackupSuffix()

Description copied from interface: FileConverter

Gets the additional file extension for backup files.

The method can return null, if this converter does not create backup files with different file extensions.

Specified by:

getBackupSuffix in interface FileConverter

Returns:

Additional file extension or null

open

public void open(String fileName)

Description copied from interface: FileConverter

This method is called when tinylog opens a log file for writing log entries.

Specified by:

open in interface FileConverter

Parameters:

fileName - Log file

write

public byte[] write(byte[] data)

Description copied from interface: FileConverter

This method can convert data before writing to the currently opened log file.

Specified by:

write in interface FileConverter

Parameters:

data - Data to write to the currently opened log file

Returns:

The passed byte array or a new byte array that should be written instead

close

public void close()

Description copied from interface: FileConverter

This method is called when tinylog closes the current log file.

Specified by:

close in interface FileConverter

shutdown

public void shutdown()
              throws InterruptedException

Description copied from interface: FileConverter

Shuts this file converter down.

If the converter has started any further threads, this method must await their termination.

Specified by:

shutdown in interface FileConverter

Throws:

InterruptedException - Interrupted while waiting