Class MessageLoggerEngine

java.lang.Object

org.apache.ivy.util.MessageLoggerEngine

All Implemented Interfaces:

MessageLogger

public class MessageLoggerEngine
extends Object
implements MessageLogger

A MessageLogger implementation delegating the work to the current top logger on a stack.

When the logger stack is empty, it delegates the work to a default logger, which by default is the Message.getDefaultLogger().

pushLogger(MessageLogger) should be called to delegate to a new logger, and popLogger() should be called when the context of this logger is finished.

Constructor Summary

Constructors

Constructor	Description
MessageLoggerEngine()

Method Summary

Modifier and Type	Method	Description
void	clearProblems()	Clears the list of problems, warns and errors.
void	debug(String msg)
void	deprecated(String msg)
void	endProgress()
void	endProgress(String msg)
void	error(String msg)
List<String>	getErrors()
List<String>	getProblems()
List<String>	getWarns()
void	info(String msg)
boolean	isShowProgress()
void	log(String msg, int level)	Logs a message at the given level.
MessageLogger	peekLogger()	Returns the current logger, or the default one if there is no logger in the stack
void	popLogger()	Pops a logger from the logger stack.
void	progress()
void	pushLogger(MessageLogger logger)	Push a logger on the stack.
void	rawinfo(String msg)
void	rawlog(String msg, int level)	Same as MessageLogger.log(String, int), but without adding any contextual information to the message.
void	setDefaultLogger(MessageLogger defaultLogger)	Sets the logger used when the stack is empty.
void	setShowProgress(boolean progress)
void	sumupProblems()	Sumup all problems encountered so far, and clear them.
void	verbose(String msg)
void	warn(String msg)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MessageLoggerEngine

public MessageLoggerEngine()

Method Details

setDefaultLogger

public void setDefaultLogger(MessageLogger defaultLogger)

Sets the logger used when the stack is empty.

Parameters:

defaultLogger - the logger to use when the stack is empty.

pushLogger

public void pushLogger(MessageLogger logger)

Push a logger on the stack.

Parameters:

logger - the logger to push. Must not be null.

popLogger

public void popLogger()

Pops a logger from the logger stack.

Does nothing if the logger stack is empty

peekLogger

public MessageLogger peekLogger()

Returns the current logger, or the default one if there is no logger in the stack

Returns:

the current logger, or the default one if there is no logger in the stack

warn

public void warn(String msg)

Specified by:

warn in interface MessageLogger

error

public void error(String msg)

Specified by:

error in interface MessageLogger

getErrors

public List<String> getErrors()

Specified by:

getErrors in interface MessageLogger

getProblems

public List<String> getProblems()

Specified by:

getProblems in interface MessageLogger

getWarns

public List<String> getWarns()

Specified by:

getWarns in interface MessageLogger

sumupProblems

public void sumupProblems()

Description copied from interface: MessageLogger

Sumup all problems encountered so far, and clear them.

Specified by:

sumupProblems in interface MessageLogger

clearProblems

public void clearProblems()

Description copied from interface: MessageLogger

Clears the list of problems, warns and errors.

Specified by:

clearProblems in interface MessageLogger

setShowProgress

public void setShowProgress(boolean progress)

Specified by:

setShowProgress in interface MessageLogger

isShowProgress

public boolean isShowProgress()

Specified by:

isShowProgress in interface MessageLogger

debug

public void debug(String msg)

Specified by:

debug in interface MessageLogger

deprecated

public void deprecated(String msg)

Specified by:

deprecated in interface MessageLogger

endProgress

public void endProgress()

Specified by:

endProgress in interface MessageLogger

endProgress

public void endProgress(String msg)

Specified by:

endProgress in interface MessageLogger

info

public void info(String msg)

Specified by:

info in interface MessageLogger

rawinfo

public void rawinfo(String msg)

Specified by:

rawinfo in interface MessageLogger

log

public void log(String msg,
 int level)

Description copied from interface: MessageLogger

Logs a message at the given level.

level constants are defined in the Message class.

Specified by:

log in interface MessageLogger

Parameters:

msg - the message to log

level - the level at which the message should be logged.

See Also:

• Message.MSG_DEBUG
• Message.MSG_VERBOSE
• Message.MSG_INFO
• Message.MSG_WARN
• Message.MSG_ERR

progress

public void progress()

Specified by:

progress in interface MessageLogger

rawlog

public void rawlog(String msg,
 int level)

Description copied from interface: MessageLogger

Same as MessageLogger.log(String, int), but without adding any contextual information to the message.

Specified by:

rawlog in interface MessageLogger

Parameters:

msg - the message to log

level - the level at which the message should be logged.

verbose

public void verbose(String msg)

Specified by:

verbose in interface MessageLogger