org.apache.log.output

Class AbstractOutputTarget

public abstract class AbstractOutputTarget extends AbstractTarget

Abstract output target. Any new output target that is writing to a single connected resource should extend this class directly or indirectly.

Author: Avalon Development Team Peter Donald

Field Summary
Formatter	m_formatter Formatter for target.

Constructor Summary
	AbstractOutputTarget() Parameterless constructor.
	AbstractOutputTarget(Formatter formatter) Creation of a new abstract output target instance.

Method Summary
void	close() Shutdown target.
protected void	doProcessEvent(LogEvent event) Process a log event.
String	format(LogEvent event) Helper method to format an event into a string, using the formatter if available.
protected Formatter	getFormatter() Returns the Formatter.
String	getHead() Helper method to retrieve head for log session.
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.
void	writeHead() Helper method to write out log head.
void	writeTail() Helper method to write out log tail.

Field Detail

m_formatter

private Formatter m_formatter

Formatter for target.

Constructor Detail

AbstractOutputTarget

public AbstractOutputTarget()

Parameterless constructor.

AbstractOutputTarget

public AbstractOutputTarget(Formatter formatter)

Creation of a new abstract output target instance.

Parameters: formatter the formatter to apply

Method Detail

close

public void close()

Shutdown target. Attempting to write to target after close() will cause errors to be logged.

doProcessEvent

protected void doProcessEvent(LogEvent event)

Process a log event.

Parameters: event the event to process

format

private String format(LogEvent event)

Helper method to format an event into a string, using the formatter if available.

Parameters: event the LogEvent

Returns: the formatted string

getFormatter

protected Formatter getFormatter()

Returns the Formatter.

getHead

private String getHead()

Helper method to retrieve head for log session. TODO: Extract from formatter

Returns: the head string

getTail

private String getTail()

Helper method to retrieve tail for log session. TODO: Extract from formatter

Returns: the head string

open

protected void open()

Startup log session.

write

protected void write(String data)

Abstract method to write data.

Parameters: 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.