org.apache.log.output
Class AbstractOutputTarget
- Closeable, ErrorAware, LogTarget
public abstract class AbstractOutputTarget
Abstract output target.
Any new output target that is writing to a single connected
resource should extend this class directly or indirectly.
void | close() - Shutdown target.
|
protected void | doProcessEvent(LogEvent event) - Process a log event.
|
private String | format(LogEvent event) - Helper method to format an event into a string, using the formatter if available.
|
protected Formatter | getFormatter() - Returns the Formatter.
|
private String | getHead() - Helper method to retrieve head for log session.
|
private String | getTail() - Helper method to retrieve tail for log session.
|
protected void | open() - Startup log session.
|
protected void | write(String data) - Abstract method to write data.
|
private void | writeHead() - Helper method to write out log head.
|
private void | writeTail() - Helper method to write out log tail.
|
m_formatter
private Formatter m_formatter
Formatter for target.
AbstractOutputTarget
public AbstractOutputTarget()
Parameterless constructor.
AbstractOutputTarget
public AbstractOutputTarget(Formatter formatter)
Creation of a new abstract output target instance.
formatter
- the formatter to apply
close
public void close()
Shutdown target.
Attempting to write to target after close() will cause errors to be logged.
- close in interface Closeable
- close in interface AbstractTarget
format
private String format(LogEvent event)
Helper method to format an event into a string, using the formatter if available.
getFormatter
protected Formatter getFormatter()
Returns the Formatter.
getHead
private String getHead()
Helper method to retrieve head for log session.
TODO: Extract from formatter
getTail
private String getTail()
Helper method to retrieve tail for log session.
TODO: Extract from formatter
write
protected void write(String data)
Abstract method to write data.
data
- the data to be output
writeHead
private void writeHead()
Helper method to write out log head.
The head initiates a session of logging.
writeTail
private void writeTail()
Helper method to write out log tail.
The tail completes a session of logging.