com.metamatrix.common.log
Interface LogConfiguration

All Superinterfaces:

java.lang.Cloneable, java.lang.Comparable

All Known Implementing Classes:

BasicLogConfiguration

public interface LogConfiguration
extends java.lang.Comparable, java.lang.Cloneable

Method Summary

java.lang.Object	clone() Clone the object.
void	discardContext(java.lang.String context) Specify that messages with the input context should be discarded and not recorded.
void	discardContexts(java.util.Collection contexts) Direct the log configuration to discard the given contexts and not record them.
java.util.Set	getDiscardedContexts() Obtain the set of contexts for messages that are to be discarded.
int	getMessageLevel() Get the level of detail of messages that are currently being recorded.
boolean	isMessageToBeRecorded(java.lang.String context, int msgLevel)
void	recordAllContexts() Direct the log configuration to record all known logging contexts.
void	recordContexts(java.util.Collection contexts) Direct the log configuration to record only these contexts.
void	setMessageLevel(int level) Direct the log configuration to record messages of the given level or above.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getDiscardedContexts

java.util.Set getDiscardedContexts()

Obtain the set of contexts for messages that are to be discarded. If this method returns an empty set, then messages in all contexts are being recorded; if not empty, then messages with a context in the returned set are discarded and messages for all other contexts recorded.

Returns:

the set of contexts for messages that are to be discarded

discardContext

void discardContext(java.lang.String context)

Specify that messages with the input context should be discarded and not recorded.

Parameters:

context - the context to add to the set; this method does nothing if the reference is null

getMessageLevel

int getMessageLevel()

Get the level of detail of messages that are currently being recorded.

Returns:

the level of detail

recordAllContexts

void recordAllContexts()

Direct the log configuration to record all known logging contexts.

clone

java.lang.Object clone()

Clone the object.

Returns:

discardContexts

void discardContexts(java.util.Collection contexts)

Direct the log configuration to discard the given contexts and not record them.

Parameters:

contexts - the collection of contexts that should be discarded.

recordContexts

void recordContexts(java.util.Collection contexts)

Direct the log configuration to record only these contexts.

Parameters:

contexts - the contexts that should be recorded.

setMessageLevel

void setMessageLevel(int level)

Direct the log configuration to record messages of the given level or above.

Parameters:

level - the lowest level to record.

isMessageToBeRecorded

boolean isMessageToBeRecorded(java.lang.String context,
                              int msgLevel)