org.apache.log.output

Class AbstractTarget

public abstract class AbstractTarget extends Object implements LogTarget, ErrorAware, Closeable

Abstract target.

Author: Avalon Development Team Peter Donald

Field Summary
static ErrorHandler	DEFAULT_ERROR_HANDLER
ErrorHandler	m_errorHandler
boolean	m_isOpen

Constructor Summary
	AbstractTarget() AbstractTarget constructor.
	AbstractTarget(ErrorHandler errorHandler) AbstractTarget constructor.

Method Summary
void	close() Shutdown target.
protected abstract void	doProcessEvent(LogEvent event) Process a log event, via formatting and outputting it.
protected ErrorHandler	getErrorHandler() Helper method to retrieve ErrorHandler for subclasses.
protected boolean	isOpen() Return the open state of the target.
protected void	open() Startup log session.
void	processEvent(LogEvent event) Process a log event, via formatting and outputting it.
void	setErrorHandler(ErrorHandler errorHandler) Provide component with ErrorHandler.

Field Detail

DEFAULT_ERROR_HANDLER

private static final ErrorHandler DEFAULT_ERROR_HANDLER

m_errorHandler

private ErrorHandler m_errorHandler

m_isOpen

private boolean m_isOpen

Constructor Detail

AbstractTarget

public AbstractTarget()

AbstractTarget constructor.

AbstractTarget

public AbstractTarget(ErrorHandler errorHandler)

AbstractTarget constructor.

Parameters: errorHandler the error handler

Method Detail

close

public void close()

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

doProcessEvent

protected abstract void doProcessEvent(LogEvent event)

Process a log event, via formatting and outputting it. This should be overidden by subclasses.

Parameters: event the log event

Throws: Exception if an event processing error occurs

getErrorHandler

protected final ErrorHandler getErrorHandler()

Helper method to retrieve ErrorHandler for subclasses.

Returns: the ErrorHandler

isOpen

protected boolean isOpen()

Return the open state of the target.

Returns: TRUE if the target is open else FALSE

open

protected void open()

Startup log session.

processEvent

public void processEvent(LogEvent event)

Process a log event, via formatting and outputting it.

Parameters: event the log event

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Provide component with ErrorHandler.

Parameters: errorHandler the errorHandler