All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.media.jfxmedia.logging.Logger Maven / Gradle / Ivy

There is a newer version: 24-ea+5
Show newest version
/*
 * Copyright (c) 2010, 2016, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.media.jfxmedia.logging;

import java.lang.annotation.Native;

/**
 * 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");
*/ public class Logger { /** * OFF is a special level that can be used to turn off logging. * This level is initialized to Integer.MAX_VALUE. */ @Native public static final int OFF = Integer.MAX_VALUE; // Maps to java.util.logging.Level.OFF /** * ERROR is a message level indicating a serious failure. * This level is initialized to 4. */ @Native public static final int ERROR = 4; // Maps to java.util.logging.Level.SEVERE /** * WARNING is a message level indicating a potential problem. * This level is initialized to 3. */ @Native public static final int WARNING = 3; // Maps to java.util.logging.Level.WARNING /** * INFO is a message level for informational messages. * This level is initialized to 2. */ @Native public static final int INFO = 2; // Maps to java.util.logging.Level.INFO /** * DEBUG is a message level providing tracing information. * This level is initialized to 1. */ @Native public static final int DEBUG = 1; // Maps to java.util.logging.Level.FINE private static int currentLevel = OFF; private static long startTime = 0; private static final Object lock = new Object(); static { startLogger(); } /** * This must be run in a privileged context */ private static void startLogger() { try { // Initialize logger Integer logLevel; String level = System.getProperty("jfxmedia.loglevel", "off").toLowerCase(); if (level.equals("debug")) { logLevel = Integer.valueOf(Logger.DEBUG); } else if (level.equals("warning")) { logLevel = Integer.valueOf(Logger.WARNING); } else if (level.equals("error")) { logLevel = Integer.valueOf(Logger.ERROR); } else if (level.equals("info")) { logLevel = Integer.valueOf(Logger.INFO); } else { logLevel = Integer.valueOf(Logger.OFF); } setLevel(logLevel.intValue()); startTime = System.currentTimeMillis(); } catch (Exception e) {} if (Logger.canLog(Logger.DEBUG)) Logger.logMsg(Logger.DEBUG, "Logger initialized"); } private Logger() { // prevent instantiation of this class } /** * Initializes logger. * This function should be called once before using any other logger functions. */ public static boolean initNative() { if (nativeInit()) { nativeSetNativeLevel(currentLevel); // Propagate level to native layer, so it will not make unnecessary JNI calls. return true; } else { return false; } } private static native boolean nativeInit(); /** * 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. * * @param level logger level */ public static void setLevel(int level) { currentLevel = level; try { nativeSetNativeLevel(level); // Propagate level to native layer, so it will not make unnecessary JNI calls. } catch(UnsatisfiedLinkError e) {} } private static native void nativeSetNativeLevel(int level); /** * Checks if message at specific level can be logged. * * @param level messgae level * @return true if message will be logged, false otherwise. */ public static boolean canLog(int level) { if (level < currentLevel) { return false; } else { return true; } } /** * Log message * * @param level message level * @param msg message */ public static void logMsg(int level, String msg) { synchronized (lock) { if (level < currentLevel) { return; } if (level == ERROR) { System.err.println("Error (" + getTimestamp() + "): " + msg); } else if (level == WARNING) { System.err.println("Warning (" + getTimestamp() + "): " + msg); } else if (level == INFO) { System.out.println("Info (" + getTimestamp() + "): " + msg); } else if (level == DEBUG) { System.out.println("Debug (" + getTimestamp() + "): " + msg); } } } /** * Log message * * @param level message level * @param sourceClass name of class that issued the logging request * @param sourceMethod name of method that issued the logging request * @param msg message */ public static void logMsg(int level, String sourceClass, String sourceMethod, String msg) { synchronized (lock) { if (level < currentLevel) { return; } logMsg(level, sourceClass + ":" + sourceMethod + "() " + msg); } } /** * Get timestamp based on current time * * @return timestamp */ private static String getTimestamp() { long elapsed = System.currentTimeMillis() - startTime; long elapsedHours = elapsed / (60 * 60 * 1000); long elapsedMinutes = (elapsed - elapsedHours * 60 * 60 * 1000) / (60 * 1000); long elapsedSeconds = (elapsed - elapsedHours * 60 * 60 * 1000 - elapsedMinutes * 60 * 1000) / 1000; long elapsedMillis = elapsed - elapsedHours * 60 * 60 * 1000 - elapsedMinutes * 60 * 1000 - elapsedSeconds * 1000; return String.format("%d:%02d:%02d:%03d", elapsedHours, elapsedMinutes, elapsedSeconds, elapsedMillis); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy