|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Appender
Implement this interface for your own strategies for outputting log statements.
Method Summary | |
---|---|
void |
addFilter(Filter newFilter)
Add a filter to the end of the filter list. |
void |
clearFilters()
Clear the list of filters by removing all the filters in it. |
void |
close()
Release any resources allocated within the appender such as file handles, network connections, etc. |
void |
doAppend(LoggingEvent event)
Log in Appender specific way. |
ErrorHandler |
getErrorHandler()
Returns the ErrorHandler for this appender. |
Filter |
getFilter()
Returns the head Filter. |
Layout |
getLayout()
Returns this appenders layout. |
String |
getName()
Get the name of this appender. |
boolean |
requiresLayout()
Configurators call this method to determine if the appender requires a layout. |
void |
setErrorHandler(ErrorHandler errorHandler)
Set the ErrorHandler for this appender. |
void |
setLayout(Layout layout)
Set the Layout for this appender. |
void |
setName(String name)
Set the name of this appender. |
Method Detail |
---|
void addFilter(Filter newFilter)
Filter getFilter()
void clearFilters()
void close()
It is a programming error to append to a closed appender.
void doAppend(LoggingEvent event)
Appender
specific way. When appropriate,
Loggers will call the doAppend
method of appender
implementations in order to log.
String getName()
void setErrorHandler(ErrorHandler errorHandler)
ErrorHandler
for this appender.
ErrorHandler getErrorHandler()
ErrorHandler
for this appender.
void setLayout(Layout layout)
Layout
for this appender.
Layout getLayout()
void setName(String name)
boolean requiresLayout()
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
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |