org.apache.log4j
Interface Appender
- AppenderSkeleton, AsyncAppender, ConsoleAppender, DailyRollingFileAppender, ExternallyRolledFileAppender, FileAppender, JDBCAppender, JMSAppender, LF5Appender, NTEventLogAppender, NullAppender, NullAppender, RollingFileAppender, SMTPAppender, SocketAppender, SocketHubAppender, SyslogAppender, TelnetAppender, WriterAppender
public interface Appender
Implement this interface for your own strategies for outputting log
statements.
addFilter
public void addFilter(Filter newFilter)
Add a filter to the end of the filter list.
clearFilters
public void clearFilters()
Clear the list of filters by removing all the filters in it.
close
public void close()
Release any resources allocated within the appender such as file
handles, network connections, etc.
It is a programming error to append to a closed appender.
doAppend
public void doAppend(LoggingEvent event)
Log in Appender
specific way. When appropriate,
Loggers will call the doAppend
method of appender
implementations in order to log.
getFilter
public Filter getFilter()
Returns the head Filter. The Filters are organized in a linked list
and so all Filters on this Appender are available through the result.
- the head Filter or null, if no Filters are present
getLayout
public Layout getLayout()
Returns this appenders layout.
getName
public String getName()
Get the name of this appender. The name uniquely identifies the
appender.
requiresLayout
public boolean requiresLayout()
Configurators call this method to determine if the appender
requires a layout. If this method returns
true
,
meaning that layout is required, then the configurator will
configure an layout using the configuration information at its
disposal. If this method returns
false
, meaning that
a layout is not required, then layout configuration will be
skipped even if there is available layout configuration
information at the disposal of the configurator..
In the rather exceptional case, where the appender
implementation admits a layout but can also work without it, then
the appender should return
true
.
setErrorHandler
public void setErrorHandler(ErrorHandler errorHandler)
setLayout
public void setLayout(Layout layout)
Set the
Layout
for this appender.
setName
public void setName(String name)
Set the name of this appender. The name is used by other
components to identify this appender.
Copyright 2000-2005 Apache Software Foundation.