Package org.tinylog.writers

Class AbstractFileBasedWriter

java.lang.Object

org.tinylog.writers.AbstractWriter

org.tinylog.writers.AbstractFileBasedWriter

All Implemented Interfaces:

Writer

Direct Known Subclasses:

AbstractFormatPatternWriter, JsonWriter

public abstract class AbstractFileBasedWriter
extends AbstractWriter

Base writer for outputting log entries into files.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFileBasedWriter(Map<String,String> properties)

Method Summary

Modifier and Type	Method	Description
protected static ByteArrayWriter	createByteArrayWriter(String fileName, boolean append, boolean buffered, boolean threadSafe, boolean shared, Charset charset)	Creates a ByteArrayWriter for a file.
protected Charset	getCharset()	Extracts the charset from configuration.
protected static byte[]	getCharsetHeader(Charset charset)	Generate the header for the passed charset (for example BOM for UTF-16).
protected String	getFileName()	Extracts the log file name from configuration.

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, getRequiredLogEntryValues, write

Constructor Detail

AbstractFileBasedWriter

protected AbstractFileBasedWriter(Map<String,String> properties)

Parameters:

properties - Configuration for writer

Method Detail

getFileName

protected String getFileName()

Extracts the log file name from configuration.

Returns:

Log file name

Throws:

IllegalArgumentException - Log file is not defined in configuration

getCharset

protected Charset getCharset()

Extracts the charset from configuration. The default charset will be returned, if no charset is defined or the defined charset doesn't exist.

Returns:

Configured charset

createByteArrayWriter

protected static ByteArrayWriter createByteArrayWriter(String fileName,
                                                       boolean append,
                                                       boolean buffered,
                                                       boolean threadSafe,
                                                       boolean shared,
                                                       Charset charset)
                                                throws IOException

Creates a ByteArrayWriter for a file.

Parameters:

fileName - Name of file to open for writing

append - An already existing file should be continued

buffered - Output should be buffered

threadSafe - Created writer must be thread-safe

shared - Output file is shared with other processes

charset - Charset used by the writer

Returns:

Writer for writing to passed file

Throws:

IOException - Log file cannot be opened for write access

getCharsetHeader

protected static byte[] getCharsetHeader(Charset charset)

Generate the header for the passed charset (for example BOM for UTF-16).

Parameters:

charset - Charset for which the header should be generated for

Returns:

Generated charset header (can be empty depending on the passed charset)