FileDocCategorySizeDatePackage
Appender.javaAPI DocApache log4j 1.2.153665Sat Aug 25 00:09:42 BST 2007org.apache.log4j

Appender

public interface Appender
Implement this interface for your own strategies for outputting log statements.
author
Ceki Gülcü

Fields Summary
Constructors Summary
Methods Summary
public voidaddFilter(org.apache.log4j.spi.Filter newFilter)
Add a filter to the end of the filter list.

since
0.9.0

public voidclearFilters()
Clear the list of filters by removing all the filters in it.

since
0.9.0

public voidclose()
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.

since
0.8.4

public voiddoAppend(org.apache.log4j.spi.LoggingEvent event)
Log in Appender specific way. When appropriate, Loggers will call the doAppend method of appender implementations in order to log.

public org.apache.log4j.spi.ErrorHandlergetErrorHandler()
Returns the {@link ErrorHandler} for this appender.

since
1.1

public org.apache.log4j.spi.FiltergetFilter()
Returns the head Filter. The Filters are organized in a linked list and so all Filters on this Appender are available through the result.

return
the head Filter or null, if no Filters are present
since
1.1

public org.apache.log4j.LayoutgetLayout()
Returns this appenders layout.

since
1.1

public java.lang.StringgetName()
Get the name of this appender. The name uniquely identifies the appender.

public booleanrequiresLayout()
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.

since
0.8.4

public voidsetErrorHandler(org.apache.log4j.spi.ErrorHandler errorHandler)
Set the {@link ErrorHandler} for this appender.

since
0.9.0

public voidsetLayout(org.apache.log4j.Layout layout)
Set the {@link Layout} for this appender.

since
0.8.1

public voidsetName(java.lang.String name)
Set the name of this appender. The name is used by other components to identify this appender.

since
0.8.1