hal/src/zutil/log/LogUtil.java

/*******************************************************************************
 * Copyright (c) 2011 Ziver Koc
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 ******************************************************************************/
package zutil.log;

import java.util.logging.ConsoleHandler;
import java.util.logging.Formatter;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Utility functions for the standard Java Logger
 * 
 * @author Ziver
 */
public class LogUtil {
	private static final Logger logger = Logger.getLogger( LogUtil.class.getName() );
	
	private LogUtil(){}

	/**
	 * @return a new Logger for the calling class
	 */
	public static Logger getLogger(){
		return Logger.getLogger(getCalingClass());
	}

	/**
	 * @return the parent class other than Logger in the stack
	 */
	public static String getCalingClass(){
		StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace();
		for(int i=1; i<stackTraceElements.length ;++i){
			String name = stackTraceElements[i].getClassName();
			if( !name.equals( LogUtil.class.getName() ) ){
				logger.fine("Calling class: \""+name+"\"");
				return name;
			}
		}
		return null;
	}

	/**
	 * Sets the log formatter to all root Handlers
	 * 
	 * @param 		f 		is the formatter class
	 */
	public static void setGlobalFormatter(Formatter f){
		Logger root = Logger.getLogger("");
		for (Handler handler : root.getHandlers()) {
			handler.setFormatter(f);
		}
	}
	
	/**
	 * Adds the log formatter to all handlers in the namespace
	 * 
	 * @param 		f 		is the formatter class
	 */
	public static void setFormatter(String name, Formatter f){
		Logger root = Logger.getLogger(name);
		for (Handler handler : root.getHandlers()) {
			handler.setFormatter(f);
		}
	}

	/**
	 * Sets the global log level
	 */
	public static void setGlobalLevel(Level level){
		setLevel("", level);
	}

	/**
	 * Addsd a Handler to the root namespace
	 */
	public static void addGlobalHandler(Handler handler){
		Logger root = Logger.getLogger("");
		root.addHandler(handler);
	}
	
	/**
	 * Sets the log level for a specified class
	 */
	public static void setLevel(Class<?> c, Level level){
		setLevel(c.getName(), level);
	}

	/**
	 * Sets the log level for a specified logger
	 */
	public static void setLevel(String name, Level level){
		logger.fine("Changing log level of \""+name+"\" to \""+level.getLocalizedName()+"\"");
		Logger logger = Logger.getLogger(name);
		logger.setLevel(level);
		// Check if the logger has a handler
		if( logger.getHandlers().length == 0 ){
			// Create a new console handler
			ConsoleHandler handler = new ConsoleHandler();
			handler.setLevel( level );
			logger.addHandler( handler );
			logger.setUseParentHandlers( false );
		}
		else{
			// Set the level on the handlers
			for (Handler handler : logger.getHandlers()) {
				handler.setLevel(level);
			}
		}
	}
}