org.apache.log4j
Class AppenderSkeleton
- Appender, OptionHandler
public abstract class AppenderSkeleton
Abstract superclass of the other appenders in the package.
This class provides the code for common functionality, such as
support for threshold filtering and support for general filters.
protected boolean | closed - Is this appender closed?
|
protected ErrorHandler | errorHandler - It is assumed and enforced that errorHandler is never null.
|
protected Filter | headFilter - The first filter in the filter chain.
|
protected Layout | layout - The layout variable does not need to be set if the appender
implementation has its own layout.
|
protected String | name - Appenders are named.
|
protected Filter | tailFilter - The last filter in the filter chain.
|
protected Priority | threshold - There is no level threshold filtering by default.
|
closed
protected boolean closed
Is this appender closed?
errorHandler
protected ErrorHandler errorHandler
It is assumed and enforced that errorHandler is never null.
headFilter
protected Filter headFilter
The first filter in the filter chain. Set to null
initially.
layout
protected Layout layout
The layout variable does not need to be set if the appender
implementation has its own layout.
name
protected String name
Appenders are named.
tailFilter
protected Filter tailFilter
The last filter in the filter chain.
threshold
protected Priority threshold
There is no level threshold filtering by default.
activateOptions
public void activateOptions()
Derived appenders should override this method if option structure
requires it.
- activateOptions in interface OptionHandler
addFilter
public void addFilter(Filter newFilter)
Add a filter to end of the filter list.
- addFilter in interface Appender
append
protected abstract void append(LoggingEvent event)
Subclasses of
AppenderSkeleton
should implement this
method to perform actual logging. See also
AppenderSkeleton.doAppend
method.
finalize
public void finalize()
Finalize this appender by calling the derived class'
close
method.
getFirstFilter
public final Filter getFirstFilter()
Return the first filter in the filter chain for this
Appender. The return value may be null
if no is
filter is set.
getLayout
public Layout getLayout()
Returns the layout of this appender. The value may be null.
- getLayout in interface Appender
getName
public final String getName()
Returns the name of this FileAppender.
- getName in interface Appender
getThreshold
public Priority getThreshold()
isAsSevereAsThreshold
public boolean isAsSevereAsThreshold(Priority priority)
Check whether the message level is below the appender's
threshold. If there is no threshold set, then the return value is
always true
.
setLayout
public void setLayout(Layout layout)
Set the layout for this appender. Note that some appenders have
their own (fixed) layouts or do not use one. For example, the
SocketAppender
ignores the layout set
here.
- setLayout in interface Appender
setName
public void setName(String name)
Set the name of this Appender.
- setName in interface Appender
setThreshold
public void setThreshold(Priority threshold)
Set the threshold level. All log events with lower level
than the threshold level are ignored by the appender.
In configuration files this option is specified by setting the
value of the
Threshold option to a level
string, such as "DEBUG", "INFO" and so on.
Copyright 2000-2005 Apache Software Foundation.