Package org.apache.log4j.varia

Class NullAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

org.apache.log4j.varia.NullAppender

All Implemented Interfaces:

Appender, OptionHandler

public class NullAppender
extends AppenderSkeleton

A NullAppender never outputs a message to any device.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.log4j.AppenderSkeleton

AppenderSkeleton.NoOpErrorHandler

Field Summary

Fields

Modifier and Type	Field	Description
private static NullAppender	INSTANCE

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

Constructors

Constructor	Description
NullAppender()

Method Summary

Modifier and Type	Method	Description
void	activateOptions()	There are no options to acticate.
protected void	append(LoggingEvent event)	Does not do anything.
void	close()	Release any resources allocated within the appender such as file handles, network connections, etc.
void	doAppend(LoggingEvent event)	Does not do anything.
NullAppender	getInstance()	Deprecated. Use getNullAppender instead.
static NullAppender	getNullAppender()	Whenever you can, use this method to retreive an instance instead of instantiating a new one with new.
boolean	requiresLayout()	NullAppenders do not need a layout.

Methods inherited from class org.apache.log4j.AppenderSkeleton

addFilter, clearFilters, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

private static final NullAppender INSTANCE

Constructor Detail

NullAppender

public NullAppender()

Method Detail

getNullAppender

public static NullAppender getNullAppender()

Whenever you can, use this method to retreive an instance instead of instantiating a new one with new.

activateOptions

public void activateOptions()

There are no options to acticate.

Specified by:

activateOptions in interface OptionHandler

Overrides:

activateOptions in class AppenderSkeleton

append

protected void append(LoggingEvent event)

Does not do anything.

Specified by:

append in class AppenderSkeleton

close

public void close()

Description copied from interface: Appender

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)

Does not do anything.

Specified by:

doAppend in interface Appender

Overrides:

doAppend in class AppenderSkeleton

Parameters:

event - The LoggingEvent.

getInstance

@Deprecated
public NullAppender getInstance()

Deprecated.

Use getNullAppender instead. getInstance should have been static.

Whenever you can, use this method to retreive an instance instead of instantiating a new one with new.

requiresLayout

public boolean requiresLayout()

NullAppenders do not need a layout.

Returns:

true if a Layout is required.