org.apache.log4j.helpers

Class AppenderAttachableImpl

java.lang.Object

org.apache.log4j.helpers.AppenderAttachableImpl

All Implemented Interfaces:

AppenderAttachable

Direct Known Subclasses:

AppenderWrapper

public class AppenderAttachableImpl
extends Object
implements AppenderAttachable

Allows Classes to attach Appenders.

Constructor Summary

Constructors

Constructor and Description
AppenderAttachableImpl()

Method Summary

Modifier and Type	Method and Description
void	addAppender(Appender newAppender) Add an appender.
int	appendLoopOnAppenders(LoggingEvent event) Call the doAppend method on all attached appenders.
void	close()
Enumeration<Appender>	getAllAppenders() Get all previously added appenders as an Enumeration.
Appender	getAppender(String name) Get an appender by name.
boolean	isAttached(Appender appender) Returns true if the specified appender is in list of attached attached, false otherwise.
void	removeAllAppenders() Remove all previously added appenders.
void	removeAppender(Appender appender) Remove the appender passed as parameter from the list of appenders.
void	removeAppender(String name) Remove the appender with the name passed as parameter from the list of appenders.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppenderAttachableImpl

public AppenderAttachableImpl()

Method Detail

addAppender

public void addAppender(Appender newAppender)

Description copied from interface: AppenderAttachable

Add an appender.

Specified by:

addAppender in interface AppenderAttachable

Parameters:

newAppender - The Appender to add.

getAllAppenders

public Enumeration<Appender> getAllAppenders()

Description copied from interface: AppenderAttachable

Get all previously added appenders as an Enumeration.

Specified by:

getAllAppenders in interface AppenderAttachable

Returns:

The Enumeration of the Appenders.

getAppender

public Appender getAppender(String name)

Description copied from interface: AppenderAttachable

Get an appender by name.

Specified by:

getAppender in interface AppenderAttachable

Parameters:

name - The name of the Appender.

Returns:

The Appender.

isAttached

public boolean isAttached(Appender appender)

Description copied from interface: AppenderAttachable

Returns true if the specified appender is in list of attached attached, false otherwise.

Specified by:

isAttached in interface AppenderAttachable

Parameters:

appender - The Appender to check.

Returns:

true if the Appender is attached.

removeAllAppenders

public void removeAllAppenders()

Description copied from interface: AppenderAttachable

Remove all previously added appenders.

Specified by:

removeAllAppenders in interface AppenderAttachable

removeAppender

public void removeAppender(Appender appender)

Description copied from interface: AppenderAttachable

Remove the appender passed as parameter from the list of appenders.

Specified by:

removeAppender in interface AppenderAttachable

Parameters:

appender - The Appender to remove.

removeAppender

public void removeAppender(String name)

Description copied from interface: AppenderAttachable

Remove the appender with the name passed as parameter from the list of appenders.

Specified by:

removeAppender in interface AppenderAttachable

Parameters:

name - The name of the Appender to remove.

appendLoopOnAppenders

public int appendLoopOnAppenders(LoggingEvent event)

Call the doAppend method on all attached appenders.

Parameters:

event - The event to log.

Returns:

The number of appenders.

close

public void close()