Class LogContext

java.lang.Object
org.jfree.util.LogContext

public class LogContext extends Object
A log context.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    The prefix string.
  • Constructor Summary

    Constructors
    Constructor
    Description
    LogContext(String contextPrefix)
    Creates a new log context.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    debug(Object message)
    A convenience method for logging a 'debug' message.
    void
    debug(Object message, Exception e)
    A convenience method for logging a 'debug' message.
    boolean
    Tests this object for equality with an arbitrary object.
    void
    error(Object message)
    A convenience method for logging an 'error' message.
    void
    error(Object message, Exception e)
    A convenience method for logging an 'error' message.
    int
    Returns a hashcode.
    void
    info(Object message)
    A convenience method for logging an 'info' message.
    void
    info(Object message, Exception e)
    A convenience method for logging an 'info' message.
    boolean
    Returns true, if the log level allows debug messages to be printed.
    boolean
    Returns true, if the log level allows error messages to be printed.
    boolean
    Returns true, if the log level allows informational messages to be printed.
    boolean
    Returns true, if the log level allows warning messages to be printed.
    void
    log(int level, Object message)
    Logs a message to the main log stream.
    void
    log(int level, Object message, Exception e)
    Logs a message to the main log stream.
    void
    warn(Object message)
    A convenience method for logging a 'warning' message.
    void
    warn(Object message, Exception e)
    A convenience method for logging a 'warning' message.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • contextPrefix

      private String contextPrefix
      The prefix string.
  • Constructor Details

    • LogContext

      public LogContext(String contextPrefix)
      Creates a new log context.
      Parameters:
      contextPrefix - the prefix.
  • Method Details

    • isDebugEnabled

      public boolean isDebugEnabled()
      Returns true, if the log level allows debug messages to be printed.
      Returns:
      true, if messages with an log level of DEBUG are allowed.
    • isInfoEnabled

      public boolean isInfoEnabled()
      Returns true, if the log level allows informational messages to be printed.
      Returns:
      true, if messages with an log level of INFO are allowed.
    • isWarningEnabled

      public boolean isWarningEnabled()
      Returns true, if the log level allows warning messages to be printed.
      Returns:
      true, if messages with an log level of WARN are allowed.
    • isErrorEnabled

      public boolean isErrorEnabled()
      Returns true, if the log level allows error messages to be printed.
      Returns:
      true, if messages with an log level of ERROR are allowed.
    • debug

      public void debug(Object message)
      A convenience method for logging a 'debug' message.
      Parameters:
      message - the message.
    • debug

      public void debug(Object message, Exception e)
      A convenience method for logging a 'debug' message.
      Parameters:
      message - the message.
      e - the exception.
    • info

      public void info(Object message)
      A convenience method for logging an 'info' message.
      Parameters:
      message - the message.
    • info

      public void info(Object message, Exception e)
      A convenience method for logging an 'info' message.
      Parameters:
      message - the message.
      e - the exception.
    • warn

      public void warn(Object message)
      A convenience method for logging a 'warning' message.
      Parameters:
      message - the message.
    • warn

      public void warn(Object message, Exception e)
      A convenience method for logging a 'warning' message.
      Parameters:
      message - the message.
      e - the exception.
    • error

      public void error(Object message)
      A convenience method for logging an 'error' message.
      Parameters:
      message - the message.
    • error

      public void error(Object message, Exception e)
      A convenience method for logging an 'error' message.
      Parameters:
      message - the message.
      e - the exception.
    • log

      public void log(int level, Object message)
      Logs a message to the main log stream. All attached log targets will also receive this message. If the given log-level is higher than the given debug-level in the main config file, no logging will be done.
      Parameters:
      level - log level of the message.
      message - text to be logged.
    • log

      public void log(int level, Object message, Exception e)
      Logs a message to the main log stream. All attached logTargets will also receive this message. If the given log-level is higher than the given debug-level in the main config file, no logging will be done.

      The exception's stacktrace will be appended to the log-stream

      Parameters:
      level - log level of the message.
      message - text to be logged.
      e - the exception, which should be logged.
    • equals

      public boolean equals(Object o)
      Tests this object for equality with an arbitrary object.
      Overrides:
      equals in class Object
      Parameters:
      o - the object to test against (null permitted).
      Returns:
      A boolean.
    • hashCode

      public int hashCode()
      Returns a hashcode.
      Overrides:
      hashCode in class Object
      Returns:
      The hashcode.