info.bioinfweb.commons.log

Interface ApplicationLogger

All Known Implementing Classes:

AbstractApplicationLogger, ApplicationLoggerDialog, ConsoleApplicationLogger, JTextAreaApplicationLogger, MessageListApplicationLogger, MultipleApplicationLoggersAdapter, SwingDocumentApplicationLogger, TextFileApplicationLogger, VoidApplicationLogger

public interface ApplicationLogger

Provides a simple logging API that can be used by applications to output log messages to the user.

Author:

Ben Stöver

Method Summary

Modifier and Type	Method and Description
void	addError(java.lang.String message) Outputs an error message to the user.
void	addError(java.lang.String message, int helpCode) Outputs an error message to the user.
void	addError(java.lang.Throwable throwable, boolean includeStackTrace) Outputs an error message to the user.
void	addError(java.lang.Throwable throwable, boolean includeStackTrace, int helpCode) Outputs an error message to the user.
void	addMessage(ApplicationLoggerMessage message) Outputs a usual message to the user.
void	addMessage(java.lang.String message) Outputs a usual message to the user.
void	addMessage(java.lang.String message, int helpCode) Outputs a usual message to the user.
void	addWarning(java.lang.String message) Outputs a warning message to the user.
void	addWarning(java.lang.String message, int helpCode) Outputs a warning message to the user.

Method Detail

addMessage

void addMessage(ApplicationLoggerMessage message)

Outputs a usual message to the user.

Parameters:

message -

addMessage

void addMessage(java.lang.String message)

Outputs a usual message to the user.

Parameters:

message -

addMessage

void addMessage(java.lang.String message,
                int helpCode)

Outputs a usual message to the user.

Parameters:

message -

helpCode - the help code associated with this messages

addWarning

void addWarning(java.lang.String message)

Outputs a warning message to the user.

Parameters:

message -

addWarning

void addWarning(java.lang.String message,
                int helpCode)

Outputs a warning message to the user.

Parameters:

message -

helpCode - the help code associated with this warning

addError

void addError(java.lang.String message)

Outputs an error message to the user.

Parameters:

message -

addError

void addError(java.lang.String message,
              int helpCode)

Outputs an error message to the user.

Parameters:

message -

helpCode - the help code associated with this warning

addError

void addError(java.lang.Throwable throwable,
              boolean includeStackTrace)

Outputs an error message to the user.

Parameters:

throwable - the Throwable describing the error

includeStackTrace - Specify true here, if you want the whole stack trace to be included in the error message or false, if only the message shall be contained in the output.

addError

void addError(java.lang.Throwable throwable,
              boolean includeStackTrace,
              int helpCode)

Outputs an error message to the user.

Parameters:

throwable - the Throwable describing the error

includeStackTrace - Specify true here, if you want the whole stack trace to be included in the error message or false, if only the message shall be contained in the output.

helpCode - the help code associated with this warning