org.apache.log4j.lf5

Class LF5Appender

public class LF5Appender extends AppenderSkeleton

LF5Appender logs events to a swing based logging console. The swing console supports turning categories on and off, multiple detail level views, as well as full text searching and many other capabilties.

Author: Brent Sprecher

Field Summary
protected static LogBrokerMonitor_defaultLogMonitor
protected static AppenderFinalizer_finalizer
protected LogBrokerMonitor_logMonitor
Constructor Summary
LF5Appender()
Constructs a LF5Appender using the default instance of the LogBrokerMonitor.
LF5Appender(LogBrokerMonitor monitor)
Constructs a LF5Appender using an instance of a LogBrokerMonitor supplied by the user.
Method Summary
voidappend(LoggingEvent event)
Appends a LoggingEvent record to the LF5Appender.
voidclose()
This method is an empty implementation of the close() method inherited from the org.apache.log4j.Appender interface.
booleanequals(LF5Appender compareTo)
The equals method compares two LF5Appenders and determines whether they are equal.
protected static LogBrokerMonitorgetDefaultInstance()
protected static intgetDefaultMonitorHeight()
protected static intgetDefaultMonitorWidth()
LogBrokerMonitorgetLogBrokerMonitor()
protected static intgetScreenHeight()
protected static intgetScreenWidth()
static voidmain(String[] args)
booleanrequiresLayout()
Returns a value that indicates whether this appender requires a Layout.
voidsetCallSystemExitOnClose(boolean callSystemExitOnClose)
This method is used to set the property that controls whether the LogBrokerMonitor is hidden or closed when a user exits the monitor.
voidsetMaxNumberOfRecords(int maxNumberOfRecords)

Field Detail

_defaultLogMonitor

protected static LogBrokerMonitor _defaultLogMonitor

_finalizer

protected static AppenderFinalizer _finalizer

_logMonitor

protected LogBrokerMonitor _logMonitor

Constructor Detail

LF5Appender

public LF5Appender()
Constructs a LF5Appender using the default instance of the LogBrokerMonitor. This constructor should always be preferred over the LF5Appender(LogBrokerMonitor monitor) constructor, unless you need to spawn additional log monitoring windows.

LF5Appender

public LF5Appender(LogBrokerMonitor monitor)
Constructs a LF5Appender using an instance of a LogBrokerMonitor supplied by the user. This constructor should only be used when you need to spawn additional log monitoring windows.

Parameters: monitor An instance of a LogBrokerMonitor created by the user.

Method Detail

append

public void append(LoggingEvent event)
Appends a LoggingEvent record to the LF5Appender.

Parameters: event The LoggingEvent to be appended.

close

public void close()
This method is an empty implementation of the close() method inherited from the org.apache.log4j.Appender interface.

equals

public boolean equals(LF5Appender compareTo)
The equals method compares two LF5Appenders and determines whether they are equal. Two Appenders will be considered equal if, and only if, they both contain references to the same LogBrokerMonitor.

Parameters: compareTo A boolean value indicating whether the two LF5Appenders are equal.

getDefaultInstance

protected static LogBrokerMonitor getDefaultInstance()

Returns: The default instance of the LogBrokerMonitor.

getDefaultMonitorHeight

protected static int getDefaultMonitorHeight()

getDefaultMonitorWidth

protected static int getDefaultMonitorWidth()

getLogBrokerMonitor

public LogBrokerMonitor getLogBrokerMonitor()

getScreenHeight

protected static int getScreenHeight()

Returns: the screen height from Toolkit.getScreenSize() if possible, otherwise returns 600

See Also: java.awt.Toolkit

getScreenWidth

protected static int getScreenWidth()

Returns: the screen width from Toolkit.getScreenSize() if possible, otherwise returns 800

See Also: java.awt.Toolkit

main

public static void main(String[] args)

requiresLayout

public boolean requiresLayout()
Returns a value that indicates whether this appender requires a Layout. This method always returns false. No layout is required for the LF5Appender.

setCallSystemExitOnClose

public void setCallSystemExitOnClose(boolean callSystemExitOnClose)
This method is used to set the property that controls whether the LogBrokerMonitor is hidden or closed when a user exits the monitor. By default, the LogBrokerMonitor will hide itself when the log window is exited, and the swing thread will continue to run in the background. If this property is set to true, the LogBrokerMonitor will call System.exit(0) and will shut down swing thread and the virtual machine.

Parameters: callSystemExitOnClose A boolean value indicating whether to call System.exit(0) when closing the log window.

setMaxNumberOfRecords

public void setMaxNumberOfRecords(int maxNumberOfRecords)
Copyright 2000-2005 Apache Software Foundation.