Package org.apache.log4j

Class AppenderSkeleton

java.lang.Object

org.apache.log4j.AppenderSkeleton

All Implemented Interfaces:

Appender, OptionHandler

Direct Known Subclasses:

NullAppender, VectorAppender, WriterAppender

public abstract class AppenderSkeleton
extends java.lang.Object
implements Appender, OptionHandler

The base class for Appenders in Log4j 1. Appenders constructed using this are ignored in Log4j 2.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AppenderSkeleton.NoOpErrorHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	closed
protected ErrorHandler	errorHandler
protected Filter	headFilter
protected Layout	layout
protected java.lang.String	name
protected Filter	tailFilter
protected Priority	threshold

Constructor Summary

Constructors

Modifier	Constructor	Description
	AppenderSkeleton()	Create new instance.
protected	AppenderSkeleton(boolean isActive)

Method Summary

Modifier and Type	Method	Description
void	activateOptions()
void	addFilter(Filter newFilter)	Add a filter to the end of the filter list.
protected abstract void	append(LoggingEvent event)
void	clearFilters()	Clear the list of filters by removing all the filters in it.
void	doAppend(LoggingEvent event)	Log in Appender specific way.
void	finalize()
ErrorHandler	getErrorHandler()	Returns the ErrorHandler for this appender.
Filter	getFilter()	Returns the head Filter.
Filter	getFirstFilter()
Layout	getLayout()	Returns this appenders layout.
java.lang.String	getName()	Get the name of this appender.
Priority	getThreshold()
boolean	isAsSevereAsThreshold(Priority priority)
void	setErrorHandler(ErrorHandler eh)	Sets the ErrorHandler for this Appender.
void	setLayout(Layout layout)	Set the Layout for this appender.
void	setName(java.lang.String name)	Set the name of this appender.
void	setThreshold(Priority threshold)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.log4j.Appender

close, requiresLayout

Field Detail

layout

protected Layout layout

name

protected java.lang.String name

threshold

protected Priority threshold

errorHandler

protected ErrorHandler errorHandler

headFilter

protected Filter headFilter

tailFilter

protected Filter tailFilter

closed

protected boolean closed

Constructor Detail

AppenderSkeleton

public AppenderSkeleton()

Create new instance.

AppenderSkeleton

protected AppenderSkeleton(boolean isActive)

Method Detail

activateOptions

public void activateOptions()

Specified by:

activateOptions in interface OptionHandler

addFilter

public void addFilter(Filter newFilter)

Description copied from interface: Appender

Add a filter to the end of the filter list.

Specified by:

addFilter in interface Appender

Parameters:

newFilter - The filter to add.

append

protected abstract void append(LoggingEvent event)

clearFilters

public void clearFilters()

Description copied from interface: Appender

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

Specified by:

clearFilters in interface Appender

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object

getErrorHandler

public ErrorHandler getErrorHandler()

Description copied from interface: Appender

Returns the ErrorHandler for this appender.

Specified by:

getErrorHandler in interface Appender

Returns:

The error handler.

getFilter

public Filter getFilter()

Description copied from interface: Appender

Returns the head Filter. The Filters are organized in a linked list and so all Filters on this Appender are available through the result.

Specified by:

getFilter in interface Appender

Returns:

the head Filter or null, if no Filters are present

getFirstFilter

public final Filter getFirstFilter()

getLayout

public Layout getLayout()

Description copied from interface: Appender

Returns this appenders layout.

Specified by:

getLayout in interface Appender

Returns:

the Layout.

getName

public final java.lang.String getName()

Description copied from interface: Appender

Get the name of this appender.

Specified by:

getName in interface Appender

Returns:

name, may be null.

getThreshold

public Priority getThreshold()

isAsSevereAsThreshold

public boolean isAsSevereAsThreshold(Priority priority)

doAppend

public void doAppend(LoggingEvent event)

Description copied from interface: Appender

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

Specified by:

doAppend in interface Appender

Parameters:

event - The LoggingEvent.

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

Sets the ErrorHandler for this Appender.

Specified by:

setErrorHandler in interface Appender

Parameters:

eh - The error handler.

Since:

0.9.0

setLayout

public void setLayout(Layout layout)

Description copied from interface: Appender

Set the Layout for this appender.

Specified by:

setLayout in interface Appender

Parameters:

layout - The Layout.

setName

public void setName(java.lang.String name)

Description copied from interface: Appender

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

Specified by:

setName in interface Appender

Parameters:

name - The appender name.

setThreshold

public void setThreshold(Priority threshold)