Package org.scijava.log

Interface LogService

All Superinterfaces:

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

All Known Implementing Classes:

AbstractLogService, StderrLogService

public interface LogService
extends SciJavaService, Logger

Interface for the logging service.

The service supports five common logging levels: ERROR, WARN, INFO, TRACE and DEBUG. It is extensible to additional levels as needed. It provides methods for logging messages, exception stack traces and combinations of the two.

Author:

Curtis Rueden, Matthias Arzt

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEBUG	Deprecated. Use LogLevel.DEBUG.
static int	ERROR	Deprecated. Use LogLevel.ERROR.
static int	INFO	Deprecated. Use LogLevel.INFO.
static String	LOG_LEVEL_BY_SOURCE_PROPERTY
static String	LOG_LEVEL_PROPERTY	System property to set for overriding the default logging level.
static int	NONE	Deprecated. Use LogLevel.NONE.
static int	TRACE	Deprecated. Use LogLevel.TRACE.
static int	WARN	Deprecated. Use LogLevel.WARN.

Method Summary

Modifier and Type	Method	Description
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.

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

addLogListener, alwaysLog, debug, debug, debug, error, error, error, getLevel, getName, getSource, info, info, info, isDebug, isError, isInfo, isLevel, isTrace, isWarn, log, log, log, notifyListeners, removeLogListener, subLogger, 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

Field Detail

LOG_LEVEL_PROPERTY

static final String LOG_LEVEL_PROPERTY

System property to set for overriding the default logging level.

See Also:

Constant Field Values

LOG_LEVEL_BY_SOURCE_PROPERTY

static final String LOG_LEVEL_BY_SOURCE_PROPERTY

See Also:

Constant Field Values

NONE

@Deprecated
static final int NONE

Deprecated.

Use LogLevel.NONE.

See Also:

Constant Field Values

ERROR

@Deprecated
static final int ERROR

Deprecated.

Use LogLevel.ERROR.

See Also:

Constant Field Values

WARN

@Deprecated
static final int WARN

Deprecated.

Use LogLevel.WARN.

See Also:

Constant Field Values

INFO

@Deprecated
static final int INFO

Deprecated.

Use LogLevel.INFO.

See Also:

Constant Field Values

DEBUG

@Deprecated
static final int DEBUG

Deprecated.

Use LogLevel.DEBUG.

See Also:

Constant Field Values

TRACE

@Deprecated
static final int TRACE

Deprecated.

Use LogLevel.TRACE.

See Also:

Constant Field Values

Method Detail

setLevel

void setLevel(int level)

Changes the log level of the root logger.

setLevel

void setLevel(String classOrPackageName,
              int level)

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

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

void setLevelForLogger(String source,
                       int level)

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