Package org.tinylog.writers

Class JsonWriter

java.lang.Object

org.tinylog.writers.AbstractWriter

org.tinylog.writers.AbstractFileBasedWriter

org.tinylog.writers.JsonWriter

All Implemented Interfaces:

Writer

public final class JsonWriter
extends AbstractFileBasedWriter

Writer for outputting log entries to a log file in JSON format. Already existing files can be continued.

Constructor Summary

Constructors

Constructor	Description
JsonWriter()
JsonWriter(Map<String,String> properties)

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.

Methods inherited from class org.tinylog.writers.AbstractFileBasedWriter

createByteArrayWriter, getCharset, getCharsetHeader, getFileName

Methods inherited from class org.tinylog.writers.AbstractWriter

getBooleanValue, getStringValue, getStringValue

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonWriter

public JsonWriter()
           throws IOException

Throws:

IOException - File not found or couldn't access file

IllegalArgumentException - Log file is not defined in configuration

JsonWriter

public JsonWriter(Map<String,String> properties)
           throws IOException

Parameters:

properties - Configuration for writer

Throws:

IOException - File not found or couldn't access file

IllegalArgumentException - Log file is not defined in configuration

Method Detail

write

public void write(LogEntry logEntry)
           throws IOException

Description copied from interface: Writer

Outputs a given log entry.

Parameters:

logEntry - Log entry to output

Throws:

IOException

flush

public void flush()
           throws IOException

Description copied from interface: Writer

Outputs buffered log entries immediately.

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: Writer

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

Throws:

IOException

getRequiredLogEntryValues

public Collection<LogEntryValue> getRequiredLogEntryValues()

Description copied from interface: Writer

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

Returns:

All returned values will be filled in passed LogEntry objects