org.apache.juli.logging

Interface Log

public interface Log

A simple logging interface abstracting logging APIs. In order to be instantiated successfully by LogFactory, classes that implement this interface must have a constructor that takes a single String parameter representing the "name" of this Log.

The six logging levels used by Log are (in order):

  1. trace (the least serious)
  2. debug
  3. info
  4. warn
  5. error
  6. fatal (the most serious)
The mapping of these log levels to the concepts used by the underlying logging system is implementation dependent. The implemention should ensure, though, that this ordering behaves as expected.

Performance is often a logging concern. By examining the appropriate property, a component can avoid expensive operations (producing information to be logged).

For example,

    if (log.isDebugEnabled()) {
        ... do something expensive ...
        log.debug(theResult);
    }
 

Configuration of the underlying logging system will generally be done external to the Logging APIs, through whatever mechanism is supported by that system.

Version: $Id: Log.java 467222 2006-10-24 03:17:11Z markt $

Author: Scott Sanders Rod Waldhoff

Method Summary
voiddebug(Object message)

Log a message with debug log level.

voiddebug(Object message, Throwable t)

Log an error with debug log level.

voiderror(Object message)

Log a message with error log level.

voiderror(Object message, Throwable t)

Log an error with error log level.

voidfatal(Object message)

Log a message with fatal log level.

voidfatal(Object message, Throwable t)

Log an error with fatal log level.

voidinfo(Object message)

Log a message with info log level.

voidinfo(Object message, Throwable t)

Log an error with info log level.

booleanisDebugEnabled()

Is debug logging currently enabled?

booleanisErrorEnabled()

Is error logging currently enabled?

booleanisFatalEnabled()

Is fatal logging currently enabled?

booleanisInfoEnabled()

Is info logging currently enabled?

booleanisTraceEnabled()

Is trace logging currently enabled?

booleanisWarnEnabled()

Is warn logging currently enabled?

voidtrace(Object message)

Log a message with trace log level.

voidtrace(Object message, Throwable t)

Log an error with trace log level.

voidwarn(Object message)

Log a message with warn log level.

voidwarn(Object message, Throwable t)

Log an error with warn log level.

Method Detail

debug

public void debug(Object message)

Log a message with debug log level.

Parameters: message log this message

debug

public void debug(Object message, Throwable t)

Log an error with debug log level.

Parameters: message log this message t log this cause

error

public void error(Object message)

Log a message with error log level.

Parameters: message log this message

error

public void error(Object message, Throwable t)

Log an error with error log level.

Parameters: message log this message t log this cause

fatal

public void fatal(Object message)

Log a message with fatal log level.

Parameters: message log this message

fatal

public void fatal(Object message, Throwable t)

Log an error with fatal log level.

Parameters: message log this message t log this cause

info

public void info(Object message)

Log a message with info log level.

Parameters: message log this message

info

public void info(Object message, Throwable t)

Log an error with info log level.

Parameters: message log this message t log this cause

isDebugEnabled

public boolean isDebugEnabled()

Is debug logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than debug.

isErrorEnabled

public boolean isErrorEnabled()

Is error logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than error.

isFatalEnabled

public boolean isFatalEnabled()

Is fatal logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than fatal.

isInfoEnabled

public boolean isInfoEnabled()

Is info logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than info.

isTraceEnabled

public boolean isTraceEnabled()

Is trace logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than trace.

isWarnEnabled

public boolean isWarnEnabled()

Is warn logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than warn.

trace

public void trace(Object message)

Log a message with trace log level.

Parameters: message log this message

trace

public void trace(Object message, Throwable t)

Log an error with trace log level.

Parameters: message log this message t log this cause

warn

public void warn(Object message)

Log a message with warn log level.

Parameters: message log this message

warn

public void warn(Object message, Throwable t)

Log an error with warn log level.

Parameters: message log this message t log this cause

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.