com.togethersoft.sca.core
Interface ILog

public interface ILog

A log broadcasts messages to the log listeners. To start receiving log messages, a log listener must register itself.

This interface is not intended to be implemented by clients.

Method Summary

void	addLogListener(ILogListener listener) Registers a log listener.
boolean	isXML() Indicates whether listeners of this log expect messages in XML format.
void	log(IMessage message) Broadcasts the message to all the registered listeners.
void	log(java.lang.String message) Broadcasts the message to all the registered listeners.
void	log(java.lang.String message, java.lang.Object[] values) Broadcasts the message to all the registered listeners.
void	removeLogListener(ILogListener listener) Unregisters a log listener.
void	setXML() Requests that messages sent to this log should be in XML format.

Method Detail

addLogListener

public void addLogListener(ILogListener listener)

Registers a log listener. A listener starts receiving log messages immediately after calling this method.

Parameters:

listener - a log listener to regsiter.

isXML

public boolean isXML()

Indicates whether listeners of this log expect messages in XML format. This will return false for a new log object.

Returns:

true if XML format was requested for this log.

log

public void log(IMessage message)

Broadcasts the message to all the registered listeners.

Parameters:

message - the message to broadcast.

See Also:

IMessage

log

public void log(java.lang.String message)

Broadcasts the message to all the registered listeners. The message severity is implicitly set to INFO.

Parameters:

message - the message to broadcast.

See Also:

IMessage

log

public void log(java.lang.String message,
                java.lang.Object[] values)

Broadcasts the message to all the registered listeners. The message severity is implicitly set to INFO.

Parameters:

message - the message to broadcast.

values - template values

See Also:

IMessage

removeLogListener

public void removeLogListener(ILogListener listener)

Unregisters a log listener. A listener stops receiving log messages immediately after calling this method.

Parameters:

listener - a log listener to unregsiter.

setXML

public void setXML()

Requests that messages sent to this log should be in XML format.