net.dpml.logging
Interface Logger


public interface Logger

Logger is a interface through which different logging solutions can be provided. Typical examples of logging implementations include java.util.logging.Logger or Ant's Project.log() function.

Version:
1.0.0
Author:
Digital Product Meta Library

Method Summary
 void debug(String message)
          Record a debug level message.
 void error(String message)
          Record a error level message.
 void error(String message, Throwable cause)
          Record a error level message.
 Logger getChildLogger(String category)
          Return a child logger relative to the current logger.
 void info(String message)
          Record a informative message.
 boolean isDebugEnabled()
          Return TRUE is debug level logging is enabled.
 boolean isErrorEnabled()
          Return TRUE is error level logging is enabled.
 boolean isInfoEnabled()
          Return TRUE is info level logging is enabled.
 boolean isTraceEnabled()
          Return TRUE is trace level logging is enabled.
 boolean isWarnEnabled()
          Return TRUE is error warning logging is enabled.
 void trace(String message)
          Record a trace level message.
 void warn(String message)
          Record a warning message.
 void warn(String message, Throwable cause)
          Record a warning message.
 

Method Detail

isDebugEnabled

public boolean isDebugEnabled()
Return TRUE is debug level logging is enabled.

Returns:
the enabled state of debug logging

isTraceEnabled

public boolean isTraceEnabled()
Return TRUE is trace level logging is enabled.

Returns:
the enabled state of trace logging

isInfoEnabled

public boolean isInfoEnabled()
Return TRUE is info level logging is enabled.

Returns:
the enabled state of info logging

isErrorEnabled

public boolean isErrorEnabled()
Return TRUE is error level logging is enabled.

Returns:
the enabled state of error logging

isWarnEnabled

public boolean isWarnEnabled()
Return TRUE is error warning logging is enabled.

Returns:
the enabled state of warning logging

debug

public void debug(String message)
Record a debug level message.

Parameters:
message - the debug message to record

trace

public void trace(String message)
Record a trace level message.

Parameters:
message - the trace message to record

info

public void info(String message)
Record a informative message.

Parameters:
message - the info message to record

warn

public void warn(String message)
Record a warning message.

Parameters:
message - the warning message to record

warn

public void warn(String message,
                 Throwable cause)
Record a warning message.

Parameters:
message - the warning message to record
cause - the causal exception

error

public void error(String message)
Record a error level message.

Parameters:
message - the error message to record

error

public void error(String message,
                  Throwable cause)
Record a error level message.

Parameters:
message - the error message to record
cause - the causal exception

getChildLogger

public Logger getChildLogger(String category)
Return a child logger relative to the current logger.

Parameters:
category - the relative category name
Returns:
the child logging channel