com.sun.media.jfxmedia.logging

Class Logger

java.lang.Object

com.sun.media.jfxmedia.logging.Logger

public class Logger
extends Object

Logger class used for logging that can output to console or file.

How to use logger in Java layer:

// Initialize logger
Logger.init();
// Set logger level
Logger.setLevel(Logger.DEBUG);

// Log some messages
// Use canLog() to check if message can be logged before doing logging. This is done for performance consideration.
if (Logger.canLog(Logger.DEBUG))
Logger.logMsg(Logger.DEBUG, "Test DEBUG message");
if (Logger.canLog(Logger.INFO))
Logger.logMsg(Logger.INFO, "Test INFO message");
if (Logger.canLog(Logger.ERROR))
Logger.logMsg(Logger.ERROR, "Test ERROR message");
if (Logger.canLog(Logger.WARNING))
Logger.logMsg(Logger.WARNING, "Test WARNING message");
if (Logger.canLog(Logger.DEBUG))
Logger.logMsg(Logger.DEBUG, "SomeClass", "SomeMethod", "Test DEBUG message");

How to use logger in Native layer:

Note: Set ENABLE_LOGGING to 1 in ProductFlags.h to enable logging in native layer.

In native levels are define as following:
LOGGER_OFF = Logger.OFF
LOGGER_ERROR = Logger.ERROR
LOGGER_WARNING = Logger.WARNING
LOGGER_INFO = Logger.INFO
LOGGER_DEBUG = Logger.DEBUG

Use following macros to log in native level:
LOGGER_LOGMSG() = void logMsg(int level, String msg)
LOGGER_LOGMSG_CM() = void logMsg(int level, String sourceClass, String sourceMethod, String msg)
Examples:
LOGGER_LOGMSG(LOGGER_DEBUG, "Initializing NativeMediaManager");
LOGGER_LOGMSG_CM(LOGGER_DEBUG, "None", "nativeInitNativeMediaManager", "Initializing NativeMediaManager");

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEBUG DEBUG is a message level providing tracing information.
static int	ERROR ERROR is a message level indicating a serious failure.
static int	INFO INFO is a message level for informational messages.
static int	OFF OFF is a special level that can be used to turn off logging.
static int	WARNING WARNING is a message level indicating a potential problem.

Method Summary

Modifier and Type	Method and Description
static boolean	canLog(int level) Checks if message at specific level can be logged.
static boolean	initNative() Initializes logger.
static void	logMsg(int level, String msg) Log message
static void	logMsg(int level, String sourceClass, String sourceMethod, String msg) Log message
static void	setLevel(int level) Sets logger level.

Methods inherited from class java.lang.Object

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

Field Detail

OFF

@Native
public static final int OFF

OFF is a special level that can be used to turn off logging. This level is initialized to Integer.MAX_VALUE.

See Also:

Constant Field Values

ERROR

@Native
public static final int ERROR

ERROR is a message level indicating a serious failure. This level is initialized to 4.

See Also:

Constant Field Values

WARNING

@Native
public static final int WARNING

WARNING is a message level indicating a potential problem. This level is initialized to 3.

See Also:

Constant Field Values

INFO

@Native
public static final int INFO

INFO is a message level for informational messages. This level is initialized to 2.

See Also:

Constant Field Values

DEBUG

@Native
public static final int DEBUG

DEBUG is a message level providing tracing information. This level is initialized to 1.

See Also:

Constant Field Values

Method Detail

initNative

public static boolean initNative()

Initializes logger. This function should be called once before using any other logger functions.

setLevel

public static void setLevel(int level)

Sets logger level. All messages below logger level will be ignored. For example, if level is set to WARNING, only messages with ERROR and WARNING levels will be logged and messages with INFO and DEBUG levels will be ignored.

Parameters:

level - logger level

canLog

public static boolean canLog(int level)

Checks if message at specific level can be logged.

Parameters:

level - messgae level

Returns:

true if message will be logged, false otherwise.

logMsg

public static void logMsg(int level,
                          String msg)

Log message

Parameters:

level - message level

msg - message

logMsg

public static void logMsg(int level,
                          String sourceClass,
                          String sourceMethod,
                          String msg)

Log message

Parameters:

level - message level

sourceClass - name of class that issued the logging request

sourceMethod - name of method that issued the logging request

msg - message