org.leafcutter.core
Interface Logger


public interface Logger

The logger used by Leafcutter. You can obtain a singleton instance of this from TaskRunner's getLogger() method and use it to write to the same logs as Leafcutter.

By default, the underlying implementation is log4j, configured by log4j.properties in the root of leafcutter.jar.

By default, only info and error messages are logged, and all logging is to the console.

Place your own log4j.properties in a directory or JAR before leafcutter.jar in your CLASSPATH if you want to confgure log4j differently.

See the User Guide for more information.

See Also:
TaskRunner.getLogger()

Method Summary
 int getErrorCount()
           
 int getWarningCount()
           
 boolean isDebugEnabled()
           
 boolean isErrorEnabled()
           
 boolean isInfoEnabled()
           
 boolean isVerboseEnabled()
           
 boolean isWarnEnabled()
           
 void log(java.lang.String message)
          Log a message at the default level (info).
 void log(java.lang.Throwable t)
          Log an exception's stack trace at error level.
 void logBanner(java.lang.String message)
          Log a banner message at "info" level.
 void logDebug(java.lang.String message)
          Log an warning message.
 void logError(java.lang.String message)
          Log an error message.
 void logInfo(java.lang.String message)
          Log an information message.
 void logVerbose(java.lang.String message)
          Log a verbose message.
 void logWarn(java.lang.String message)
          Log an warning message.
 void logWarningBanner(java.lang.String message)
          Log a banner message at "warning" level.
 void setDebug(boolean enabled)
          Enable or disable debug messages.
 void setError(boolean enabled)
          Enable or disable error messages.
 void setInfo(boolean enabled)
          Enable or disable info messages.
 boolean setMaxLineLength(int length)
          Optional method which sets the maximum length of lines output by the logger Implementors can choose to implement this as a "do-nothing" method which should return false
 void setVerbose(boolean enabled)
          Enable or disable verbose messages.
 void setWarn(boolean enabled)
          Enable or disable warning messages.
 

Method Detail

log

void log(java.lang.String message)
Log a message at the default level (info). Method log.

Parameters:
message - The message to log

logError

void logError(java.lang.String message)
Log an error message. Method log.

Parameters:
message - The message to log

logInfo

void logInfo(java.lang.String message)
Log an information message. Method log.

Parameters:
message - The message to log

logWarn

void logWarn(java.lang.String message)
Log an warning message. Method log.

Parameters:
message - The message to log

logDebug

void logDebug(java.lang.String message)
Log an warning message. Method log.

Parameters:
message - The message to log

logVerbose

void logVerbose(java.lang.String message)
Log a verbose message. Method log.

Parameters:
message - The message to log

logBanner

void logBanner(java.lang.String message)
Log a banner message at "info" level. For example:
 ###########################
 # Starting build
 ###########################
 
Method log.

Parameters:
message - The message to log

logWarningBanner

void logWarningBanner(java.lang.String message)
Log a banner message at "warning" level. For example:
 ###########################
 # Be careful!!
 ###########################
 
Method log.

Parameters:
message - The message to log

log

void log(java.lang.Throwable t)
Log an exception's stack trace at error level. Method log.

Parameters:
message - The message to log

getWarningCount

int getWarningCount()
Returns:

getErrorCount

int getErrorCount()
Returns:

setDebug

void setDebug(boolean enabled)
Enable or disable debug messages. Also enables or disables verbose messages. This is overriden by the configuration of the underlying logger implementation.

Parameters:
enabled -

setError

void setError(boolean enabled)
Enable or disable error messages. This is overriden by the configuration of the underlying logger implementation.

Parameters:
enabled -

setInfo

void setInfo(boolean enabled)
Enable or disable info messages. This is overriden by the configuration of the underlying logger implementation.

Parameters:
enabled -

setVerbose

void setVerbose(boolean enabled)
Enable or disable verbose messages. Also enables or disables debug messages. This is overriden by the configuration of the underlying logger implementation.

Parameters:
enabled -

setWarn

void setWarn(boolean enabled)
Enable or disable warning messages. This is overriden by the configuration of the underlying logger implementation.

Parameters:
enabled -

isDebugEnabled

boolean isDebugEnabled()
Returns:
True if debug is enabled

isErrorEnabled

boolean isErrorEnabled()
Returns:
True if error is enabled

isInfoEnabled

boolean isInfoEnabled()
Returns:
True if info is enabled

isVerboseEnabled

boolean isVerboseEnabled()
Returns:
True if verbose is enabled

isWarnEnabled

boolean isWarnEnabled()
Returns:
True if warn is enabled

setMaxLineLength

boolean setMaxLineLength(int length)
Optional method which sets the maximum length of lines output by the logger Implementors can choose to implement this as a "do-nothing" method which should return false

Parameters:
length -
Returns:
true iff the operation is supported.