Package org.pmw.tinylog.writers

Interface Writer

All Known Implementing Classes:

ConsoleWriter, FileWriter, JdbcWriter, LogcatWriter, RollingFileWriter, SharedFileWriter

public interface Writer

Writers output created log entries from Logger.

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

Example:
@PropertiesSupport(name = "example", properties = { @Property(name = "filename", type = String.class), @Property(name = "backups", type = int.class) })
public final class ExampleWriter implements Writer {

A writer must have a constructor that matches to the defined properties.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the writer and release all resources.
void	flush()	Flush this writer and force any buffered data to output.
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).
void	write(LogEntry logEntry)	Write a log entry.

Method Detail

getRequiredLogEntryValues

Set<LogEntryValue> getRequiredLogEntryValues()

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

Returns:

Required values for log entry

init

void init(Configuration configuration)
   throws Exception

Initialize the writer (open a file for example).

Parameters:

configuration - Configuration of logger

Throws:

Exception - Failed to initialize the writer

write

void write(LogEntry logEntry)
    throws Exception

Write a log entry.

Parameters:

logEntry - Log entry to output

Throws:

Exception - Failed to write the log entry

flush

void flush()
    throws Exception

Flush this writer and force any buffered data to output.

Throws:

Exception - Failed to flush

close

void close()
    throws Exception

Close the writer and release all resources. If a writer required a close() call, it should be registered in the init() method at VMShutdownHook for automatically shutdown when VM will be shutdown.

Throws:

Exception - Failed to close the writer