Package org.apache.log4j.lf5
Class LF5Appender
java.lang.Object
org.apache.log4j.AppenderSkeleton
org.apache.log4j.lf5.LF5Appender
- All Implemented Interfaces:
Appender
,OptionHandler
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
FieldsModifier and TypeFieldDescriptionprotected static org.apache.log4j.lf5.viewer.LogBrokerMonitor
protected static AppenderFinalizer
protected org.apache.log4j.lf5.viewer.LogBrokerMonitor
Fields inherited from class org.apache.log4j.AppenderSkeleton
closed, errorHandler, headFilter, layout, name, tailFilter, threshold
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs aLF5Appender
using the default instance of theLogBrokerMonitor
.LF5Appender
(org.apache.log4j.lf5.viewer.LogBrokerMonitor monitor) Constructs aLF5Appender
using an instance of a
LogBrokerMonitor
supplied by the user.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
append
(LoggingEvent event) Appends aLoggingEvent
record to theLF5Appender
.void
close()
This method is an empty implementation of the close() method inherited from theorg.apache.log4j.Appender
interface.boolean
equals
(LF5Appender compareTo) The equals method compares two LF5Appenders and determines whether they are equal.protected static org.apache.log4j.lf5.viewer.LogBrokerMonitor
protected static int
protected static int
org.apache.log4j.lf5.viewer.LogBrokerMonitor
protected static int
protected static int
static void
boolean
Returns a value that indicates whether this appender requires aLayout
.void
setCallSystemExitOnClose
(boolean callSystemExitOnClose) This method is used to set the property that controls whether theLogBrokerMonitor
is hidden or closed when a user exits the monitor.void
setMaxNumberOfRecords
(int maxNumberOfRecords) Methods inherited from class org.apache.log4j.AppenderSkeleton
activateOptions, addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold
-
Field Details
-
_logMonitor
protected org.apache.log4j.lf5.viewer.LogBrokerMonitor _logMonitor -
_defaultLogMonitor
protected static org.apache.log4j.lf5.viewer.LogBrokerMonitor _defaultLogMonitor -
_finalizer
-
-
Constructor Details
-
LF5Appender
public LF5Appender()Constructs aLF5Appender
using the default instance of theLogBrokerMonitor
. This constructor shouldalways be preferred over theLF5Appender(LogBrokerMonitor monitor)
constructor, unless you need to spawn additional log monitoring windows. -
LF5Appender
public LF5Appender(org.apache.log4j.lf5.viewer.LogBrokerMonitor monitor) Constructs aLF5Appender
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 aLogBrokerMonitor
created by the user.
-
-
Method Details
-
append
Appends aLoggingEvent
record to theLF5Appender
.- Specified by:
append
in classAppenderSkeleton
- Parameters:
event
- TheLoggingEvent
to be appended.
-
close
public void close()This method is an empty implementation of the close() method inherited from theorg.apache.log4j.Appender
interface. -
requiresLayout
public boolean requiresLayout()Returns a value that indicates whether this appender requires aLayout
. This method always returns false. No layout is required for theLF5Appender
. -
setCallSystemExitOnClose
public void setCallSystemExitOnClose(boolean callSystemExitOnClose) This method is used to set the property that controls whether theLogBrokerMonitor
is hidden or closed when a user exits the monitor. By default, theLogBrokerMonitor
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, theLogBrokerMonitor
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.
-
equals
The equals method compares two LF5Appenders and determines whether they are equal. TwoAppenders
will be considered equal if, and only if, they both contain references to the sameLogBrokerMonitor
.- Parameters:
compareTo
- A boolean value indicating whether the two LF5Appenders are equal.
-
getLogBrokerMonitor
public org.apache.log4j.lf5.viewer.LogBrokerMonitor getLogBrokerMonitor() -
main
-
setMaxNumberOfRecords
public void setMaxNumberOfRecords(int maxNumberOfRecords) -
getDefaultInstance
protected static org.apache.log4j.lf5.viewer.LogBrokerMonitor getDefaultInstance()- Returns:
- The default instance of the
LogBrokerMonitor
.
-
getScreenWidth
protected static int getScreenWidth()- Returns:
- the screen width from Toolkit.getScreenSize() if possible, otherwise returns 800
- See Also:
-
getScreenHeight
protected static int getScreenHeight()- Returns:
- the screen height from Toolkit.getScreenSize() if possible, otherwise returns 600
- See Also:
-
getDefaultMonitorWidth
protected static int getDefaultMonitorWidth() -
getDefaultMonitorHeight
protected static int getDefaultMonitorHeight()
-