Package org.tinylog.writers

Class AbstractFormatPatternWriter

java.lang.Object

org.tinylog.writers.AbstractWriter

org.tinylog.writers.AbstractFileBasedWriter

org.tinylog.writers.AbstractFormatPatternWriter

All Implemented Interfaces:

Writer

Direct Known Subclasses:

AbstractSocketWriter, ConsoleWriter, FileWriter, RollingFileWriter, SharedFileWriter, SyslogWriter

public abstract class AbstractFormatPatternWriter
extends AbstractFileBasedWriter

Base writer for outputting rendered log entries. The format pattern will be read from property format.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Collection<LogEntryValue>	getRequiredLogEntryValues()	Gets all log entry values that are required for rendering a log entry by the defined format pattern.
protected String	render(LogEntry logEntry)	Renders a log entry as string.

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

Methods inherited from interface org.tinylog.writers.Writer

close, flush, write

Constructor Detail

AbstractFormatPatternWriter

public AbstractFormatPatternWriter(Map<String,String> properties)

Parameters:

properties - Configuration for writer

Method Detail

getRequiredLogEntryValues

public Collection<LogEntryValue> getRequiredLogEntryValues()

Gets all log entry values that are required for rendering a log entry by the defined format pattern. If a child writer requires additional log entries, this method has to be overridden.

Returns:

Required log entry values

render

protected final String render(LogEntry logEntry)

Renders a log entry as string.

Parameters:

logEntry - Log entry to render

Returns:

Rendered log entry