LogMonitorAdapter (Apache Log4j 1.2.17 API)
Date: 2012-05-06

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.log4j.lf5.util
Class LogMonitorAdapter

    java.lang.Object
      org.apache.log4j.lf5.util.LogMonitorAdapter

    public class LogMonitorAdapter

extends Object

LogMonitorAdapter facilitates the usage of the LogMonitor

Author:
  Richard Hurst

Field Summary
`static int` | `JDK14_LOG_LEVELS`
`static int` | `LOG4J_LOG_LEVELS`

Method Summary
`void` | `addMessage(LogRecord record)` Adds a LogRecord to the LogMonitor.
`LogLevel` | `getDefaultLevel()` Gets the default LogLevel for the Adapter.
`protected static int` | `getDefaultMonitorHeight()`
`protected static int` | `getDefaultMonitorWidth()`
`protected static int` | `getScreenHeight()`
`protected static int` | `getScreenWidth()`
`LogLevel` | `getSevereLevel()` Gets the current Severe LogLevel
`void` | `log(String category, LogLevel level, String message)` Log a message to the Monitor.
`void` | `log(String category, LogLevel level, String message, String NDC)` Log a message to the Monitor.
`void` | `log(String category, LogLevel level, String message, Throwable t)` Log a message to the Monitor.
`void` | `log(String category, LogLevel level, String message, Throwable t, String NDC)` Log a complete message to the Monitor.
`void` | `log(String category, String message)` Log a message to the Monitor and use the default LogLevel.
`static LogMonitorAdapter` | `newInstance(int loglevels)` Creates an instance of LogMonitorAdapter using the log levels inticated by the parameter.
`static LogMonitorAdapter` | `newInstance(List userDefinedLevels)` Creates an instance of LogMonitorAdapter using the specified LogLevels.
`static LogMonitorAdapter` | `newInstance(LogLevel[] userDefined)` Creates an instance of LogMonitorAdapter using the specified LogLevels.
`void` | `setDefaultLevel(LogLevel level)` Set the default log level to be used when logging messages without specifying a LogLevel.
`void` | `setMaxNumberOfRecords(int maxNumberOfRecords)` Set the maximum number of records to be displayed in the monitor
`void` | `setSevereLevel(LogLevel level)` Sets the Severe LogLevel.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### LOG4J_LOG_LEVELS

    public static final int LOG4J_LOG_LEVELS

See Also:
  Constant Field Values

### JDK14_LOG_LEVELS

    public static final int JDK14_LOG_LEVELS

See Also:
  Constant Field Values

Method Detail

### newInstance

    public static LogMonitorAdapter newInstance(int loglevels)

  Creates an instance of LogMonitorAdapter using the log levels inticated by the parameter. Log4J and JDK1.4 both have default LogLevels which are set but these levels can be overriden.

  Parameters:
    `loglevels` - An integer representing either Log4J or JDK1.4 logging levels
  Returns:
    LogMonitorAdapter

### newInstance

    public static LogMonitorAdapter newInstance(LogLevel[] userDefined)

  Creates an instance of LogMonitorAdapter using the specified LogLevels. The first LogLevel in the array is used as the default LogLevel unless changed using the setDefaultLevel method.

  Parameters:
    `userDefined` - An array of user defined LogLevel objects.
  Returns:
    LogMonitorAdapter

### newInstance

    public static LogMonitorAdapter newInstance(List userDefinedLevels)

  Creates an instance of LogMonitorAdapter using the specified LogLevels. The first LogLevel in the List is used as the default LogLevel unless changed using the setDefaultLevel method.

  Parameters:
    `userDefinedLevels` - A list of user defined LogLevel objects.
  Returns:
    LogMonitorAdapter

### addMessage

    public void addMessage(LogRecord record)

  Adds a LogRecord to the LogMonitor.

  Parameters:
    `record` - The LogRecord object to be logged in the logging monitor.

### setMaxNumberOfRecords

    public void setMaxNumberOfRecords(int maxNumberOfRecords)

  Set the maximum number of records to be displayed in the monitor

  Parameters:
    `maxNumberOfRecords` -

### setDefaultLevel

    public void setDefaultLevel(LogLevel level)

  Set the default log level to be used when logging messages without specifying a LogLevel.

  Parameters:
    `level` -

### getDefaultLevel

    public LogLevel getDefaultLevel()

  Gets the default LogLevel for the Adapter.

  Returns:
    LogLevel

### setSevereLevel

    public void setSevereLevel(LogLevel level)

  Sets the Severe LogLevel.

  Parameters:
    `level` -

### getSevereLevel

    public LogLevel getSevereLevel()

  Gets the current Severe LogLevel

  Returns:
    LogLevel

### log

    public void log(String category,
                    LogLevel level,
                    String message,
                    Throwable t,
                    String NDC)

  Log a complete message to the Monitor.

  Parameters:
    `category` - The category to be used
    `level` - The log level to apply to the message
    `message` - The message
    `t` - The throwable content of the message
    `NDC` - The NDC really only applies to Log4J and the parameter can usually be ignored.

### log

    public void log(String category,
                    String message)

  Log a message to the Monitor and use the default LogLevel.

  Parameters:
    `category` - The category to be used
    `message` - The message

### log

    public void log(String category,
                    LogLevel level,
                    String message,
                    String NDC)

  Log a message to the Monitor.

  Parameters:
    `category` - The category to be used
    `level` - The log level to apply to the message
    `message` - The message
    `NDC` -

### log

    public void log(String category,
                    LogLevel level,
                    String message,
                    Throwable t)

  Log a message to the Monitor.

  Parameters:
    `category` - The category to be used
    `level` - The log level to apply to the message
    `message` - The message
    `t` - The throwable content of the message

### log

    public void log(String category,
                    LogLevel level,
                    String message)

  Log a message to the Monitor.

  Parameters:
    `category` - The category to be used
    `level` - The log level to apply to the message
    `message` - The message

### getScreenWidth

    protected static int getScreenWidth()

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

### getScreenHeight

    protected static int getScreenHeight()

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

### getDefaultMonitorWidth

    protected static int getDefaultMonitorWidth()

### getDefaultMonitorHeight

    protected static int getDefaultMonitorHeight()

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2012 Apache Software Foundation. All Rights Reserved.