org.apache.log4j
public class WriterAppender extends AppenderSkeleton
Since: 1.1
Field Summary | |
---|---|
protected String | encoding
The encoding to use when writing. |
protected boolean | immediateFlush
Immediate flush means that the underlying writer or output stream
will be flushed at the end of each append operation. |
protected QuietWriter | qw
This is the quietWriter where we will write
to. |
Constructor Summary | |
---|---|
WriterAppender()
This default constructor does nothing. | |
WriterAppender(Layout layout, OutputStream os)
Instantiate a WriterAppender and set the output destination to a
new OutputStreamWriter initialized with os
as its OutputStream. | |
WriterAppender(Layout layout, Writer writer)
Instantiate a WriterAppender and set the output destination to
writer .
|
Method Summary | |
---|---|
void | activateOptions()
Does nothing. |
void | append(LoggingEvent event)
This method is called by the AppenderSkeleton
method.
|
protected boolean | checkEntryConditions()
This method determines if there is a sense in attempting to append.
|
void | close()
Close this appender instance. |
protected void | closeWriter()
Close the underlying java.io.Writer.
|
protected OutputStreamWriter | createWriter(OutputStream os)
Returns an OutputStreamWriter when passed an OutputStream. |
String | getEncoding() |
boolean | getImmediateFlush()
Returns value of the ImmediateFlush option. |
boolean | requiresLayout()
The WriterAppender requires a layout. |
protected void | reset()
Clear internal references to the writer and other variables.
|
void | setEncoding(String value) |
void | setErrorHandler(ErrorHandler eh)
Set the ErrorHandler for this WriterAppender and also the
underlying QuietWriter if any. |
void | setImmediateFlush(boolean value)
If the ImmediateFlush option is set to
true , the appender will flush at the end of each
write. |
void | setWriter(Writer writer) Sets the Writer where the log output will go. |
protected void | subAppend(LoggingEvent event)
Actual writing occurs here.
|
protected void | writeFooter()
Write a footer as produced by the embedded layout's Layout method. |
protected void | writeHeader()
Write a header as produced by the embedded layout's Layout method. |
The
encoding
variable is set to null by
default which results in the utilization of the system's default
encoding.
immediateFlush
is set to
false
, then there is a good chance that the last few
logs events are not actually written to persistent media if and
when the application crashes.
The immediateFlush
variable is set to
true
by default.
quietWriter
where we will write
to.os
as its OutputStream.writer
.
The writer
must have been previously opened by
the user.
If the output stream exists and is writable then write a log
statement to the output stream. Otherwise, write a single warning
message to System.err
.
The format of the output will depend on this appender's layout.
It checks whether there is a set output target and also if
there is a set layout. If these checks fail, then the boolean
value false
is returned.
Closed appenders cannot be reused.
Since: 0.8.4
See Also: WriterAppender
encoding
property. If the encoding value is
specified incorrectly the writer will be opened using the default
system encoding (an error message will be printed to the loglog.true
.true
, the appender will flush at the end of each
write. This is the default behavior. If the option is set to
false
, then the underlying stream can defer writing
to physical medium to a later time.
Avoiding the flush operation at the end of each append results in a performance gain of 10 to 20 percent. However, there is safety tradeoff involved in skipping flushing. Indeed, when flushing is skipped, then it is likely that the last few log events will not be recorded on disk when the application exits. This is a high price to pay even for a 20% performance gain.
Sets the Writer where the log output will go. The specified Writer must be opened by the user and be writable.
The java.io.Writer
will be closed when the
appender instance is closed.
WARNING: Logging to an unopened Writer will fail.
Parameters: writer An already opened Writer.
Most subclasses of WriterAppender
will need to
override this method.
Since: 0.9.0