public interface

Appender

org.apache.log4j.Appender
Known Indirect Subclasses

Class Overview

Implement this interface for your own strategies for outputting log statements.

Summary

Public Methods
abstract void addFilter(Filter newFilter)
Add a filter to the end of the filter list.
abstract void clearFilters()
Clear the list of filters by removing all the filters in it.
abstract void close()
Release any resources allocated within the appender such as file handles, network connections, etc.
abstract void doAppend(LoggingEvent event)
Log in Appender specific way.
abstract ErrorHandler getErrorHandler()
Returns the ErrorHandler for this appender.
abstract Filter getFilter()
Returns the head Filter.
abstract Layout getLayout()
Returns this appenders layout.
abstract String getName()
Get the name of this appender.
abstract boolean requiresLayout()
Configurators call this method to determine if the appender requires a layout.
abstract void setErrorHandler(ErrorHandler errorHandler)
Set the ErrorHandler for this appender.
abstract void setLayout(Layout layout)
Set the Layout for this appender.
abstract void setName(String name)
Set the name of this appender.

Public Methods

public abstract void addFilter (Filter newFilter)

Add a filter to the end of the filter list.

public abstract void clearFilters ()

Clear the list of filters by removing all the filters in it.

public abstract 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.

public abstract void doAppend (LoggingEvent event)

Log in Appender specific way. When appropriate, Loggers will call the doAppend method of appender implementations in order to log.

public abstract ErrorHandler getErrorHandler ()

Returns the ErrorHandler for this appender.

public abstract 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.

Returns
  • the head Filter or null, if no Filters are present

public abstract Layout getLayout ()

Returns this appenders layout.

public abstract String getName ()

Get the name of this appender.

Returns
  • name, may be null.

public abstract 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.

public abstract void setErrorHandler (ErrorHandler errorHandler)

Set the ErrorHandler for this appender.

public abstract void setLayout (Layout layout)

Set the Layout for this appender.

public abstract void setName (String name)

Set the name of this appender. The name is used by other components to identify this appender.