cern.gp.logging

Class NetBeansLog

java.lang.Object

cern.gp.logging.NetBeansLog

public class NetBeansLog
extends java.lang.Object

NetBeans implementation of Log that uses the default ErrorManager. The following system properties are supported to configure the behavior of this logger:

• LOG_LEVEL_PROPERTY - Default logging detail level for all instances of NetBeansLog. Must be one of ("trace", "debug", "info", "warn", "error", or "fatal"). If not specified, defaults to LOG_LEVEL_DEFAULT.
• SHOW_LOG_NAME_PROPERTY - Set to true if you want the Log instance name to be included in output messages. Defaults to SHOW_LOG_NAME_DEFAULT
• SHOW_SHORT_LOG_NAME_PROPERTY - Set to true if you want the last component of the name to be included in output messages. Defaults to SHOW_SHORT_LOG_NAME_DEFAULT.
• SHOW_DATE_TIME_PROPERTY - Set to true if you want the current date and time to be included in output messages. Default is SHOW_DATE_TIME_DEFAULT.
• SYSTEM_PREFIX.log.xxxxx - Logging detail level for a NetBeansLog instance named "xxxxx". Must be one of ("trace", "debug", "info", "warn", "error", or "fatal"). If not specified, the default logging detail level is used.

In addition to looking for system properties with the names specified above, this implementation also checks for a class loader resource named #LOG_PROPERTIES, and includes any matching definitions from this resource (if it exists).

Author:

Katarina Sigerud

Field Summary

Fields

Modifier and Type	Field and Description
protected int	currentLogLevel The current log level
static java.lang.String	DATE_FORMAT_DEFAULT
static java.lang.String	DATE_FORMAT_PROPERTY
protected static java.text.DateFormat	dateFormatter
protected static ErrorManager	errMgr
static int	LOG_LEVEL_ALL Enable all logging levels
static int	LOG_LEVEL_DEBUG "Finer" level logging (ErrorManager.INFORMATIONAL + 1)
static java.lang.String	LOG_LEVEL_DEFAULT
static int	LOG_LEVEL_ERROR "Warning" level logging = ErrorManager.EXCEPTION
static int	LOG_LEVEL_FATAL "Severe" level logging = ErrorManager.ERROR
static int	LOG_LEVEL_INFO "Config" level logging (ErrorManager.WARNING).
static int	LOG_LEVEL_OFF Disable all logging levels
static java.lang.String	LOG_LEVEL_PROPERTY
static int	LOG_LEVEL_TRACE "Finest" level logging (Debug window).
static int	LOG_LEVEL_WARN "Info" level logging (ErrorManager.USER)
protected java.lang.String	logName The name of this simple log instance
protected static java.util.Properties	nblogProps
static boolean	SHOW_DATE_TIME_DEFAULT
static java.lang.String	SHOW_DATE_TIME_PROPERTY
static boolean	SHOW_LOG_NAME_DEFAULT
static java.lang.String	SHOW_LOG_NAME_PROPERTY
static boolean	SHOW_SHORT_LOG_NAME_DEFAULT
static java.lang.String	SHOW_SHORT_LOG_NAME_PROPERTY
protected static boolean	showDateTime
protected static boolean	showLogName
protected static boolean	showShortName
static java.lang.String	SYSTEM_PREFIX

Constructor Summary

Constructors

Constructor and Description
NetBeansLog(java.lang.String name) Construct a simple log with given name.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	createLogMessage(int type, java.lang.Object message)
void	debug(java.lang.Object message)
void	debug(java.lang.Object message, java.lang.Throwable t)
protected void	display(int logLevel, java.lang.Object message, java.lang.Throwable t)
void	error(java.lang.Object message)
void	error(java.lang.Object message, java.lang.Throwable t)
void	fatal(java.lang.Object message)
void	fatal(java.lang.Object message, java.lang.Throwable t)
int	getLevel() Get logging level.
void	info(java.lang.Object message)
void	info(java.lang.Object message, java.lang.Throwable t)
boolean	isDebugEnabled()
boolean	isErrorEnabled()
boolean	isFatalEnabled()
boolean	isInfoEnabled()
protected boolean	isLevelEnabled(int logLevel) Is the given log level currently enabled?
boolean	isTraceEnabled()
boolean	isWarnEnabled()
protected void	log(int type, java.lang.Object msg, java.lang.Throwable t) Do the actual logging.
void	setLevel(int currentLogLevel) Set logging level.
void	trace(java.lang.Object message)
void	trace(java.lang.Object message, java.lang.Throwable t)
void	warn(java.lang.Object message)
void	warn(java.lang.Object message, java.lang.Throwable t)

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_PREFIX

public static final java.lang.String SYSTEM_PREFIX

See Also:

Constant Field Values

LOG_LEVEL_PROPERTY

public static final java.lang.String LOG_LEVEL_PROPERTY

See Also:

Constant Field Values

SHOW_LOG_NAME_PROPERTY

public static final java.lang.String SHOW_LOG_NAME_PROPERTY

See Also:

Constant Field Values

SHOW_SHORT_LOG_NAME_PROPERTY

public static final java.lang.String SHOW_SHORT_LOG_NAME_PROPERTY

See Also:

Constant Field Values

SHOW_DATE_TIME_PROPERTY

public static final java.lang.String SHOW_DATE_TIME_PROPERTY

See Also:

Constant Field Values

DATE_FORMAT_PROPERTY

public static final java.lang.String DATE_FORMAT_PROPERTY

See Also:

Constant Field Values

DATE_FORMAT_DEFAULT

public static final java.lang.String DATE_FORMAT_DEFAULT

See Also:

Constant Field Values

LOG_LEVEL_DEFAULT

public static final java.lang.String LOG_LEVEL_DEFAULT

See Also:

Constant Field Values

SHOW_LOG_NAME_DEFAULT

public static final boolean SHOW_LOG_NAME_DEFAULT

See Also:

Constant Field Values

SHOW_SHORT_LOG_NAME_DEFAULT

public static final boolean SHOW_SHORT_LOG_NAME_DEFAULT

See Also:

Constant Field Values

SHOW_DATE_TIME_DEFAULT

public static final boolean SHOW_DATE_TIME_DEFAULT

See Also:

Constant Field Values

errMgr

protected static final ErrorManager errMgr

nblogProps

protected static final java.util.Properties nblogProps

showLogName

protected static boolean showLogName

showShortName

protected static boolean showShortName

showDateTime

protected static boolean showDateTime

dateFormatter

protected static java.text.DateFormat dateFormatter

LOG_LEVEL_TRACE

public static final int LOG_LEVEL_TRACE

"Finest" level logging (Debug window).

LOG_LEVEL_DEBUG

public static final int LOG_LEVEL_DEBUG

"Finer" level logging (ErrorManager.INFORMATIONAL + 1)

LOG_LEVEL_INFO

public static final int LOG_LEVEL_INFO

"Config" level logging (ErrorManager.WARNING).

LOG_LEVEL_WARN

public static final int LOG_LEVEL_WARN

"Info" level logging (ErrorManager.USER)

LOG_LEVEL_ERROR

public static final int LOG_LEVEL_ERROR

"Warning" level logging = ErrorManager.EXCEPTION

LOG_LEVEL_FATAL

public static final int LOG_LEVEL_FATAL

"Severe" level logging = ErrorManager.ERROR

LOG_LEVEL_ALL

public static final int LOG_LEVEL_ALL

Enable all logging levels

LOG_LEVEL_OFF

public static final int LOG_LEVEL_OFF

Disable all logging levels

logName

protected java.lang.String logName

The name of this simple log instance

currentLogLevel

protected int currentLogLevel

The current log level

Constructor Detail

NetBeansLog

public NetBeansLog(java.lang.String name)

Construct a simple log with given name.

Parameters:

name - log name

Method Detail

setLevel

public void setLevel(int currentLogLevel)

Set logging level.

Parameters:

level - new logging level

getLevel

public int getLevel()

Get logging level.

isTraceEnabled

public boolean isTraceEnabled()

isDebugEnabled

public boolean isDebugEnabled()

isInfoEnabled

public boolean isInfoEnabled()

isWarnEnabled

public boolean isWarnEnabled()

isErrorEnabled

public boolean isErrorEnabled()

isFatalEnabled

public boolean isFatalEnabled()

trace

public void trace(java.lang.Object message)

trace

public void trace(java.lang.Object message,
                  java.lang.Throwable t)

debug

public void debug(java.lang.Object message)

debug

public void debug(java.lang.Object message,
                  java.lang.Throwable t)

info

public void info(java.lang.Object message)

info

public void info(java.lang.Object message,
                 java.lang.Throwable t)

warn

public void warn(java.lang.Object message)

warn

public void warn(java.lang.Object message,
                 java.lang.Throwable t)

error

public void error(java.lang.Object message)

error

public void error(java.lang.Object message,
                  java.lang.Throwable t)

fatal

public void fatal(java.lang.Object message)

fatal

public void fatal(java.lang.Object message,
                  java.lang.Throwable t)

display

protected void display(int logLevel,
                       java.lang.Object message,
                       java.lang.Throwable t)

log

protected void log(int type,
                   java.lang.Object msg,
                   java.lang.Throwable t)

Do the actual logging. This method assembles the message and then logs using the default ErrorManager.

createLogMessage

protected java.lang.String createLogMessage(int type,
                                            java.lang.Object message)

isLevelEnabled

protected boolean isLevelEnabled(int logLevel)

Is the given log level currently enabled?

Parameters:

logLevel - is this level enabled?