org.gpel.logger

Class GLogger

java.lang.Object

org.gpel.logger.GLogger

public class GLogger
extends Object

This is really small simplementationm of logging that is self-contained (it is just one class!) and very easy to use simply configurable from command line using system properties or from inside of your application if you desire so (see setCmdNames()).

Version:

$Revision: 1.5 $ $Date: 2006/12/07 04:55:33 $ (GMT)

Author:

Aleksander Slominski [http://www.extreme.indiana.edu/~aslom]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GLogger.Level
static class	GLogger.Log Logging class that can be switched off completly to deliver max performance if required (just set Log.ON to false)
static class	GLogger.LogManager

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_NESTING_LEVEL
static GLogger	global
static String	PROPERTY_DEBUG
static String	PROPERTY_LOG
static String	PROPERTY_PREFIX
static String	PROPERTY_SHOWTIME
static String	PROPERTY_WRAPCOL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GLogger(String name, String resourceBundleName)

Method Summary

Methods

Modifier and Type	Method and Description
Throwable	caught(String sourceClass, String sourceMethod, Throwable thrown)
Throwable	caught(Throwable thrown) report that exception was caught with log message at FINER level and "CAUGHT" message
void	config(String msg)
void	config(String msg, Throwable thrown)
void	entering() Log a method entry with Level.FINER and message "ENTRY"
void	entering(Object param1) Log a method entry with Level.FINER and message "ENTRY" and parametr content appended
void	entering(Object[] params) Log a method entry with Level.FINER and message "ENTRY" and parametrs content appended
void	entering(String sourceClass, String sourceMethod)
void	entering(String sourceClass, String sourceMethod, Object param1)
void	entering(String sourceClass, String sourceMethod, Object[] params)
void	exiting() Log a method return with Level.FINER and message "RETURN"
Object	exiting(Object result) Log a method return with Level.FINER and message "RETURN" and return value appended
void	exiting(String sourceClass, String sourceMethod)
Object	exiting(String sourceClass, String sourceMethod, Object result)
void	fine(String msg)
void	fine(String msg, Throwable thrown)
void	finer(String msg)
void	finer(String msg, Throwable thrown)
void	finest(String msg)
void	finest(String msg, Throwable thrown)
static void	formatTime(long time, StringBuffer buf)
static GLogger	getAnonymousMLogger()
GLogger.Level	getLevel()
static GLogger	getLogger()
static GLogger	getLogger(String name)
static boolean	getMultiline()
String	getName()
static boolean	getShowTime()
static PrintStream	getSink()
static int	getWrapCol()
void	info(String msg)
void	info(String msg, Throwable thrown)
boolean	isConfigEnabled()
boolean	isFineEnabled()
boolean	isFinerEnabled()
boolean	isFinestEnabled()
boolean	isInfoEnabled()
boolean	isLoggable(GLogger.Level level)
boolean	isSevereEnabled()
boolean	isWariningEnabled()
void	log(GLogger.Level level, String msg)
void	log(GLogger.Level level, String msg, Object param1)
void	log(GLogger.Level level, String msg, Object[] params)
void	log(GLogger.Level level, String msg, Throwable thrown)
void	logg(GLogger.Level level, String msg)
void	logg(GLogger.Level level, String msg, Throwable thrown)
void	logg(GLogger.Level level, String msg, Throwable thrown, int nestingLevel)
static String	parametersToList(Object[] params)
static void	setCmdNames(String names) Enables list of loggers passed as string parameter.
void	setLevel(GLogger.Level newLevel)
static void	setMultiline(boolean enable)
static void	setShowTime(boolean enable)
static void	setSink(PrintStream ps)
static void	setWrapCol(int i)
void	severe(String msg)
void	severe(String msg, Throwable thrown)
Throwable	throwing(String sourceClass, String sourceMethod, Throwable thrown)
Throwable	throwing(Throwable thrown) Log an exception thrown with Level.FINER and message "THROW" and exception appended
String	toString()
void	warning(String msg)
void	warning(String msg, Throwable thrown)

Methods inherited from class java.lang.Object

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

Field Detail

global

public static final GLogger global

PROPERTY_PREFIX

public static final String PROPERTY_PREFIX

See Also:

Constant Field Values

PROPERTY_LOG

public static final String PROPERTY_LOG

See Also:

Constant Field Values

PROPERTY_SHOWTIME

public static final String PROPERTY_SHOWTIME

See Also:

Constant Field Values

PROPERTY_DEBUG

public static final String PROPERTY_DEBUG

See Also:

Constant Field Values

PROPERTY_WRAPCOL

public static final String PROPERTY_WRAPCOL

See Also:

Constant Field Values

DEFAULT_NESTING_LEVEL

public static final int DEFAULT_NESTING_LEVEL

See Also:

Constant Field Values

Constructor Detail

GLogger

protected GLogger(String name,
       String resourceBundleName)

Method Detail

getAnonymousMLogger

public static GLogger getAnonymousMLogger()

getLogger

public static GLogger getLogger()

getLogger

public static GLogger getLogger(String name)

getName

public String getName()

isLoggable

public boolean isLoggable(GLogger.Level level)

isSevereEnabled

public final boolean isSevereEnabled()

isWariningEnabled

public final boolean isWariningEnabled()

isInfoEnabled

public final boolean isInfoEnabled()

isConfigEnabled

public final boolean isConfigEnabled()

isFineEnabled

public final boolean isFineEnabled()

isFinerEnabled

public final boolean isFinerEnabled()

isFinestEnabled

public final boolean isFinestEnabled()

setLevel

public void setLevel(GLogger.Level newLevel)

getLevel

public GLogger.Level getLevel()

parametersToList

public static String parametersToList(Object[] params)

entering

public void entering()

Log a method entry with Level.FINER and message "ENTRY"

entering

public void entering(String sourceClass,
            String sourceMethod)

entering

public void entering(Object param1)

Log a method entry with Level.FINER and message "ENTRY" and parametr content appended

entering

public void entering(String sourceClass,
            String sourceMethod,
            Object param1)

entering

public void entering(Object[] params)

Log a method entry with Level.FINER and message "ENTRY" and parametrs content appended

entering

public void entering(String sourceClass,
            String sourceMethod,
            Object[] params)

exiting

public void exiting()

Log a method return with Level.FINER and message "RETURN"

exiting

public void exiting(String sourceClass,
           String sourceMethod)

exiting

public Object exiting(Object result)

Log a method return with Level.FINER and message "RETURN" and return value appended

exiting

public Object exiting(String sourceClass,
             String sourceMethod,
             Object result)

throwing

public Throwable throwing(Throwable thrown)

Log an exception thrown with Level.FINER and message "THROW" and exception appended

throwing

public Throwable throwing(String sourceClass,
                 String sourceMethod,
                 Throwable thrown)

caught

public Throwable caught(Throwable thrown)

report that exception was caught with log message at FINER level and "CAUGHT" message

caught

public Throwable caught(String sourceClass,
               String sourceMethod,
               Throwable thrown)

severe

public void severe(String msg)

warning

public void warning(String msg)

info

public void info(String msg)

config

public void config(String msg)

fine

public void fine(String msg)

finer

public void finer(String msg)

finest

public void finest(String msg)

log

public void log(GLogger.Level level,
       String msg)

log

public void log(GLogger.Level level,
       String msg,
       Throwable thrown)

log

public void log(GLogger.Level level,
       String msg,
       Object param1)

log

public void log(GLogger.Level level,
       String msg,
       Object[] params)

severe

public void severe(String msg,
          Throwable thrown)

warning

public void warning(String msg,
           Throwable thrown)

info

public void info(String msg,
        Throwable thrown)

config

public void config(String msg,
          Throwable thrown)

fine

public void fine(String msg,
        Throwable thrown)

finer

public void finer(String msg,
         Throwable thrown)

finest

public void finest(String msg,
          Throwable thrown)

getSink

public static PrintStream getSink()

setSink

public static void setSink(PrintStream ps)

logg

public void logg(GLogger.Level level,
        String msg)

logg

public void logg(GLogger.Level level,
        String msg,
        Throwable thrown)

logg

public void logg(GLogger.Level level,
        String msg,
        Throwable thrown,
        int nestingLevel)

setCmdNames

public static void setCmdNames(String names)

Enables list of loggers passed as string parameter. Format: [logger_name:LEVEL][,...] logger_name is package[.class] or any name that was given when creating logger with MLogger.getMLogger("name"); LEVEL -s execatly name of Level such as ALL, FINE, etc. (see Level class)

getMultiline

public static boolean getMultiline()

setMultiline

public static void setMultiline(boolean enable)

getWrapCol

public static int getWrapCol()

setWrapCol

public static void setWrapCol(int i)

getShowTime

public static boolean getShowTime()

setShowTime

public static void setShowTime(boolean enable)

formatTime

public static void formatTime(long time,
              StringBuffer buf)

toString

public String toString()

Overrides:

toString in class Object