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
protected Formatterm_formatter
Formatter for target.
Constructor Summary
AbstractOutputTarget()
Parameterless constructor.
AbstractOutputTarget(Formatter formatter)
Creation of a new abstract output target instance.
Method Summary
voidclose()
Shutdown target.
protected voiddoProcessEvent(LogEvent event)
Process a log event.
FormattergetFormatter()
Retrieve the associated formatter.
protected voidopen()
Startup log session.
protected voidoutput(String data)
Abstract method that will output event.
voidsetFormatter(Formatter formatter)
Set the formatter.
protected voidwrite(String data)
Abstract method to write data.

Field Detail

m_formatter

protected Formatter m_formatter

Deprecated: You should not be directly accessing this attribute as it will become private next release

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

getFormatter

public Formatter getFormatter()

Deprecated: Access to formatter is not advised and this method will be removed in future iterations. It remains only for backwards compatability.

Retrieve the associated formatter.

Returns: the formatter

open

protected void open()
Startup log session.

output

protected void output(String data)

Deprecated: User should overide write() instead of output(). Output exists for backwards compatability and will be removed in future.

Abstract method that will output event.

Parameters: data the data to be output

setFormatter

public void setFormatter(Formatter formatter)

Deprecated: In future this method will become protected access.

Set the formatter.

Parameters: formatter the formatter

write

protected void write(String data)
Abstract method to write data.

Parameters: data the data to be output