org.apache.log.output

Class AbstractWrappingTarget

Implemented Interfaces:
Closeable, ErrorAware, LogTarget
Known Direct Subclasses:
AsyncLogTarget

public abstract class AbstractWrappingTarget
extends AbstractTarget

Abstract base class for targets that wrap other targets. The class provides functionality for optionally closing a wrapped target that implements org.apache.log.util.Closeable.
Author:
Avalon Development Team
See Also:
Closeable

Field Summary

private boolean
m_closeWrapped
private LogTarget
m_wrappedLogTarget

Fields inherited from class org.apache.log.output.AbstractTarget

DEFAULT_ERROR_HANDLER, m_errorHandler, m_isOpen

Constructor Summary

AbstractWrappingTarget(LogTarget logTarget)
Creation of a new wrapping log target.
AbstractWrappingTarget(LogTarget logTarget, boolean closeWrappedTarget)
Creation of a new wrapping log target.

Method Summary

void
close()
Shutdown target.
protected LogTarget
getLogTarget()
Return the target for subclasses

Methods inherited from class org.apache.log.output.AbstractTarget

close, doProcessEvent, getErrorHandler, isOpen, open, processEvent, setErrorHandler

Field Details

m_closeWrapped

private final boolean m_closeWrapped

m_wrappedLogTarget

private final LogTarget m_wrappedLogTarget

Constructor Details

AbstractWrappingTarget

public AbstractWrappingTarget(LogTarget logTarget)
Creation of a new wrapping log target. The underlying log target will not be closed when this target is closed.
Parameters:
logTarget - the underlying target

AbstractWrappingTarget

public AbstractWrappingTarget(LogTarget logTarget,
                              boolean closeWrappedTarget)
Creation of a new wrapping log target.
Parameters:
logTarget - the underlying target
closeWrappedTarget - boolean flag indicating whether the wrapped log target should be closed when this target is closed. Note: This flag has no effect unless the underlying target implements org.apache.log.util.Closeable.
See Also:
Closeable

Method Details

close

public void close()
Shutdown target. Attempting to write to target after close() will cause errors to be logged.
Specified by:
close in interface Closeable
Overrides:
close in interface AbstractTarget

getLogTarget

protected final LogTarget getLogTarget()
Return the target for subclasses