Package org.scijava.log

Class AbstractLogService

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.service.AbstractService

org.scijava.log.AbstractLogService

All Implemented Interfaces:

Comparable<Prioritized>, Contextual, Disposable, Identifiable, Initializable, Locatable, Logged, Logger, LogService, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, SciJavaService, Service, Versioned

Direct Known Subclasses:

StderrLogService

public abstract class AbstractLogService
extends AbstractService
implements LogService

Base class for LogService implementations.

Author:

Johannes Schindelin, Curtis Rueden, Matthias Arzt

Field Summary

Fields inherited from interface org.scijava.log.LogService

DEBUG, ERROR, INFO, LOG_LEVEL_BY_SOURCE_PROPERTY, LOG_LEVEL_PROPERTY, NONE, TRACE, WARN

Constructor Summary

Constructors

Constructor	Description
AbstractLogService()
AbstractLogService(Properties properties)

Method Summary

Modifier and Type	Method	Description
void	addLogListener(LogListener listener)	Adds an item to the list of registered listeners.
void	alwaysLog(int level, Object msg, Throwable t)	Logs a message with an exception.
int	getLevel()	Returns the log level of this logger. see LogLevel
protected String	getPrefix(int level)	Deprecated. Use LogLevel.prefix(int) instead.
LogSource	getSource()	Returns the LogSource associated with this logger.
protected abstract void	messageLogged(LogMessage message)
void	notifyListeners(LogMessage event)	Broadcasts the given log message to the registered listeners.
void	removeLogListener(LogListener listener)	Removes an item from the list of registered listeners.
void	setLevel(int level)	Changes the log level of the root logger.
void	setLevel(String classOrPackageName, int level)	For messages that are logged directly to the LogService.
void	setLevelForLogger(String source, int level)	Setting the log level for loggers depending on their LogSource.
Logger	subLogger(String name, int level)	Creates a sub logger, that forwards the message it gets to this logger.

Methods inherited from class org.scijava.service.AbstractService

getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual

context

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Disposable

dispose

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.log.Logger

debug, debug, debug, error, error, error, getName, info, info, info, isDebug, isError, isInfo, isLevel, isTrace, isWarn, log, log, log, subLogger, trace, trace, trace, warn, warn, warn

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.Versioned

getVersion

Constructor Detail

AbstractLogService

public AbstractLogService()

AbstractLogService

public AbstractLogService(Properties properties)

Method Detail

setLevel

public void setLevel(int level)

Description copied from interface: LogService

Changes the log level of the root logger.

Specified by:

setLevel in interface LogService

setLevel

public void setLevel(String classOrPackageName,
                     int level)

Description copied from interface: LogService

For messages that are logged directly to the LogService. The log level can be set depending on the class that makes the log.

Specified by:

setLevel in interface LogService

Parameters:

classOrPackageName - If this is the name of a class. Messages logged directly by this class are logged, if the message's level is less or equal to the given level. If this is a package, the same holds for all classes in this package.

level - Given level.

setLevelForLogger

public void setLevelForLogger(String source,
                              int level)

Description copied from interface: LogService

Setting the log level for loggers depending on their LogSource. This will only affect loggers that are created after this method has been called.

Specified by:

setLevelForLogger in interface LogService

messageLogged

protected abstract void messageLogged(LogMessage message)

alwaysLog

public void alwaysLog(int level,
                      Object msg,
                      Throwable t)

Description copied from interface: Logger

Logs a message with an exception. This message will always be logged even if its level is above the current level (given by Logger.getLevel()).

Specified by:

alwaysLog in interface Logger

Parameters:

level - The level at which the information will be logged.

msg - The message to log.

t - The exception to log.

getSource

public LogSource getSource()

Description copied from interface: Logger

Returns the LogSource associated with this logger.

Specified by:

getSource in interface Logger

getLevel

public int getLevel()

Description copied from interface: Logger

Returns the log level of this logger. see LogLevel

Specified by:

getLevel in interface Logger

subLogger

public Logger subLogger(String name,
                        int level)

Description copied from interface: Logger

Creates a sub logger, that forwards the message it gets to this logger.

Specified by:

subLogger in interface Logger

Parameters:

name - The name of the sub logger.

level - The log level of the sub logger.

addLogListener

public void addLogListener(LogListener listener)

Description copied from interface: Logger

Adds an item to the list of registered listeners.

Specified by:

addLogListener in interface Logger

removeLogListener

public void removeLogListener(LogListener listener)

Description copied from interface: Logger

Removes an item from the list of registered listeners.

Specified by:

removeLogListener in interface Logger

notifyListeners

public void notifyListeners(LogMessage event)

Description copied from interface: Logger

Broadcasts the given log message to the registered listeners.

Specified by:

notifyListeners in interface Logger

getPrefix

@Deprecated
protected String getPrefix(int level)

Deprecated.

Use LogLevel.prefix(int) instead.