Package org.pmw.tinylog.writers

Class FileWriter

java.lang.Object

org.pmw.tinylog.writers.FileWriter

All Implemented Interfaces:

Writer

public final class FileWriter
extends Object
implements Writer

Writes log entries to a file.

Constructor Summary

Constructors

Constructor	Description
FileWriter(String filename)
FileWriter(String filename, boolean buffered)
FileWriter(String filename, boolean buffered, boolean append)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the log file.
void	flush()	Flush this writer and force any buffered data to output.
String	getFilename()	Get the filename of the log file.
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).
boolean	isAppending()	Determine whether appending is enabled.
boolean	isBuffered()	Determine whether buffered writing is enabled.
void	write(LogEntry logEntry)	Write a log entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileWriter

public FileWriter(String filename)

Parameters:

filename - Filename of the log file

FileWriter

public FileWriter(String filename,
                  boolean buffered)

Parameters:

filename - Filename of the log file

buffered - Buffered writing

FileWriter

public FileWriter(String filename,
                  boolean buffered,
                  boolean append)

Parameters:

filename - Filename of the log file

buffered - Buffered writing

append - Continuing existing file

Method Detail

getRequiredLogEntryValues

public Set<LogEntryValue> getRequiredLogEntryValues()

Description copied from interface: Writer

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

Specified by:

getRequiredLogEntryValues in interface Writer

Returns:

Required values for log entry

getFilename

public String getFilename()

Get the filename of the log file.

Returns:

Filename of the log file

isBuffered

public boolean isBuffered()

Determine whether buffered writing is enabled.

Returns:

true if buffered writing is enabled, otherwise false

isAppending

public boolean isAppending()

Determine whether appending is enabled.

Returns:

true if appending is enabled, otherwise false

init

public void init(Configuration configuration)
          throws IOException

Description copied from interface: Writer

Initialize the writer (open a file for example).

Specified by:

init in interface Writer

Parameters:

configuration - Configuration of logger

Throws:

IOException

write

public void write(LogEntry logEntry)
           throws IOException

Description copied from interface: Writer

Write a log entry.

Specified by:

write in interface Writer

Parameters:

logEntry - Log entry to output

Throws:

IOException

flush

public void flush()
           throws IOException

Description copied from interface: Writer

Flush this writer and force any buffered data to output.

Specified by:

flush in interface Writer

Throws:

IOException

close

public void close()
           throws IOException

Close the log file.

Specified by:

close in interface Writer

Throws:

IOException - Failed to close the log file