Package org.tinylog.writers

Interface Writer

All Known Implementing Classes:

AbstractFileBasedWriter, AbstractFormatPatternWriter, AbstractSocketWriter, AbstractWriter, ConsoleWriter, FileWriter, JdbcWriter, JsonWriter, LogcatWriter, RollingFileWriter, SharedFileWriter, SyslogWriter, TcpSocketWriter, UdpSocketWriter

public interface Writer

Writers output issued log entries.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the writer.
void	flush()	Outputs buffered log entries immediately.
Collection<LogEntryValue>	getRequiredLogEntryValues()	Returns all log entry values that are required for outputting a log entry.
void	write(LogEntry logEntry)	Outputs a given log entry.

Method Detail

getRequiredLogEntryValues

Collection<LogEntryValue> getRequiredLogEntryValues()

Returns all log entry values that are required for outputting a log entry.

Returns:

All returned values will be filled in passed LogEntry objects

write

void write(LogEntry logEntry)
    throws Exception

Outputs a given log entry.

Parameters:

logEntry - Log entry to output

Throws:

Exception - Any exception can be thrown if writing has been failed

flush

void flush()
    throws Exception

Outputs buffered log entries immediately.

Throws:

Exception - Any exception can be thrown if flushing has been failed

close

void close()
    throws Exception

Closes the writer. All allocated resources should be released in this method.

Throws:

Exception - Any exception can be thrown if closing has been failed