Package de.uka.ipd.sdq.workflow.logging.console

Class AppenderBasedStreamMonitor

java.lang.Object

de.uka.ipd.sdq.workflow.logging.console.AppenderBasedStreamMonitor

All Implemented Interfaces:

IAppenderListener, IStreamMonitor

public class AppenderBasedStreamMonitor
extends Object
implements IStreamMonitor, IAppenderListener

Base class of appender monitors. An appender monitor watches its added appenders for newly added log lines. Whenever a new log line arrives at one of the appenders, this monitor sends out an notification event to Eclipse which then updates its GUI or file based logs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AppenderBasedStreamMonitor.ComparisonOperator	The Enum ComparisonOperator.

Constructor Summary

Constructors

Constructor	Description
AppenderBasedStreamMonitor(org.apache.log4j.Level logLevel, AppenderBasedStreamMonitor.ComparisonOperator op)	Base class constructor.

Method Summary

Modifier and Type	Method	Description
void	addAppender(StreamsProxyAppender appender)	Add an appender of type StreamsProxyAppender to this monitor.
void	addListener(IStreamListener listener)
String	getContents()
protected void	notifyListeners(String text)	Helper method which informs all listeners of the newly recorded text.
void	removeAppender(StreamsProxyAppender appender)	Removes the appender.
void	removeListener(IStreamListener listener)
void	textAddedEvent(String text, org.apache.log4j.Level level)	Event handler method which is called by an appender whenever a new log message arrives.

Methods inherited from class java.lang.Object

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

Constructor Details

AppenderBasedStreamMonitor

public AppenderBasedStreamMonitor(org.apache.log4j.Level logLevel,
 AppenderBasedStreamMonitor.ComparisonOperator op)

Base class constructor.

Parameters:

logLevel - the log level

op - the op

Method Details

addListener

public void addListener(IStreamListener listener)

Specified by:

addListener in interface IStreamMonitor

removeListener

public void removeListener(IStreamListener listener)

Specified by:

removeListener in interface IStreamMonitor

getContents

public String getContents()

Specified by:

getContents in interface IStreamMonitor

addAppender

public void addAppender(StreamsProxyAppender appender)

Add an appender of type StreamsProxyAppender to this monitor. Whenever you write something to the added appender, this monitor will notify all its listeners of the newly added text if it is responsible for it (depending on the log level, see subclasses of this class)

Parameters:

appender - A Log4J appender which will be used to write to Eclipse's run console

removeAppender

public void removeAppender(StreamsProxyAppender appender)

Removes the appender.

Parameters:

appender - the appender

notifyListeners

protected void notifyListeners(String text)

Helper method which informs all listeners of the newly recorded text.

Parameters:

text - The new text on one of the Log4J appenders

textAddedEvent

public void textAddedEvent(String text,
 org.apache.log4j.Level level)

Description copied from interface: IAppenderListener

Event handler method which is called by an appender whenever a new log message arrives. The handler can then decide what to do with the new log message

Specified by:

textAddedEvent in interface IAppenderListener

Parameters:

text - The formatted log message

level - The log level of the log message used to filter events