de.opsdesign.yax.log
Interface LogListener

All Known Implementing Classes:

AntLogger, ConsoleLogger, Log4jLogger, Logger

public interface LogListener

Method Summary

java.lang.String	getLogMessage(YaxEvent yaxEvent) Builds the message string from all information of a yaxEvent
java.lang.String	getSeverityLabel(int severity) Maps the severity code to the right label
boolean	isAntLogger() Returns true, if implementing class logs for the ant task YaxTask.
void	log(java.lang.String message) Notifies all loggers (LogListeners) to log an INFO message.
void	log(java.lang.String message, int severity) Notifies all loggers (LogListeners) to log a message with a particular severity.
void	log(YaxEvent yaxEvent) Notifies all loggers (LogListeners) to log an elaborated message (for exceptions et al).

Method Detail

log

void log(java.lang.String message)

Notifies all loggers (LogListeners) to log an INFO message. This signature is for normal INFO messages. (The severity will be set to the default INFO).

Parameters:

message - message to log

log

void log(java.lang.String message,
         int severity)

Notifies all loggers (LogListeners) to log a message with a particular severity. This signature is deditated for messages with a severity other than INFO.

Parameters:

message - message to log

severity - log severity(Log.ERROR,-WARN,-INFO,-VERBOSE or -DEBUG)

log

void log(YaxEvent yaxEvent)

Notifies all loggers (LogListeners) to log an elaborated message (for exceptions et al). This signature is deditated especially for exceptions and events with elaborated log requirements.

Parameters:

yaxEvent - consist of all relevant event information (also complete information about message exception)

getLogMessage

java.lang.String getLogMessage(YaxEvent yaxEvent)

Builds the message string from all information of a yaxEvent

Parameters:

yaxEvent - consist of all relevant event information (also complete information about message exception)

Returns:

message ready to use to log output

getSeverityLabel

java.lang.String getSeverityLabel(int severity)

Maps the severity code to the right label

Parameters:

severity - log severity(Log.ERROR,-WARN,-INFO,-VERBOSE or -DEBUG)

Returns:

label string that corresponds with the severity code

isAntLogger

boolean isAntLogger()

Returns true, if implementing class logs for the ant task YaxTask.

When yax runs in Ant-mode, all yax will be redirected to ant.

Returns:

true, if the implementing class is an AntLogger, otherwise false.