org.ckkloverdos.log
Class StdLogger

java.lang.Object
  extended by org.ckkloverdos.log.StdLogger

public class StdLogger
extends java.lang.Object

A simple logging class. This a very limited logging API but with many utility methods, usually not found in more complete APIs.

Author:
Christos KK Loverdos

Field Summary
static java.lang.String DEBUG
           
static java.lang.String ERROR
           
static java.lang.String INFO
           
static java.lang.String WARN
           
 
Constructor Summary
StdLogger()
           
StdLogger(java.lang.String uid)
          Constructs a new instance for which all output will include the provided uid.
StdLogger(java.lang.String uid, boolean printDate)
          Constructs a new instance for which all output will include the provided uid and the date/time of the logging call.
StdLogger(java.lang.String uid, java.lang.String where)
          Constructs a new instance for which all output will include the provided uid and a description of where the logging call is made.
StdLogger(java.lang.String uid, java.lang.String where, boolean printDate)
           
 
Method Summary
 void debug(java.lang.Object msg)
           
 void debug(java.lang.Object o, java.lang.Throwable e)
           
 void debug(java.lang.String msg)
           
 void debug(java.lang.String key, java.lang.Object val)
           
 void debug(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2)
           
 void debug(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3)
           
 void debug(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4)
           
 void debug(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4, java.lang.String k5, java.lang.Object v5)
           
 void debug(java.lang.String msg, java.lang.String key, java.lang.Object val)
           
 void debug(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2)
           
 void debug(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3)
           
 void debug(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4)
           
 void debug(java.lang.String msg, java.lang.Throwable e)
           
 void debug(java.lang.Throwable e)
           
 void debug(ToString msg)
           
 void debug(ToString msg, java.lang.Throwable e)
           
 void enter()
           
 void error(java.lang.Object msg)
           
 void error(java.lang.Object o, java.lang.Throwable e)
           
 void error(java.lang.String msg)
           
 void error(java.lang.String key, java.lang.Object val)
           
 void error(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2)
           
 void error(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3)
           
 void error(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4)
           
 void error(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4, java.lang.String k5, java.lang.Object v5)
           
 void error(java.lang.String msg, java.lang.String key, java.lang.Object val)
           
 void error(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2)
           
 void error(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3)
           
 void error(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4)
           
 void error(java.lang.String msg, java.lang.Throwable e)
           
 void error(java.lang.Throwable e)
           
 void error(ToString msg)
           
 void error(ToString msg, java.lang.Throwable e)
           
 void exit()
           
 StdLogger forSite(java.lang.String where)
          Constructs a new instance for with the description given by where will be appended the the information of the calling site.
 java.lang.String getUID()
           
 java.lang.String getWhere()
           
 StdLogger indent()
           
 void info(java.lang.Object msg)
           
 void info(java.lang.Object o, java.lang.Throwable e)
           
 void info(java.lang.String key, java.lang.Object val)
           
 void info(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2)
           
 void info(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3)
           
 void info(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4)
           
 void info(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4, java.lang.String k5, java.lang.Object v5)
           
 void info(java.lang.String msg, java.lang.String key, java.lang.Object val)
           
 void info(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2)
           
 void info(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3)
           
 void info(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4)
           
 void info(java.lang.String msg, java.lang.Throwable e)
           
 void info(java.lang.Throwable e)
           
 void info(ToString msg)
           
 void info(ToString msg, java.lang.Throwable e)
           
 void log(boolean b)
           
 void log(java.lang.Object msg)
           
 void log(java.lang.String msg)
           
 void log(java.lang.String key, java.lang.Object val)
           
 void log(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2)
           
 void log(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3)
           
 void log(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4)
           
 void log(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4, java.lang.String k5, java.lang.Object v5)
           
 void log(java.lang.String msg, java.lang.String key, java.lang.Object val)
           
 void log(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2)
           
 void log(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3)
           
 void log(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4)
           
 void log(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4, java.lang.String k5, java.lang.Object v5)
           
 void log(java.lang.Throwable msg)
           
 void log(ToString msg)
           
 void setUID(java.lang.String uid)
           
 void setWhere(java.lang.String where)
           
 StdLogger unindent()
           
 void warn(java.lang.Object msg)
           
 void warn(java.lang.Object o, java.lang.Throwable e)
           
 void warn(java.lang.String msg)
           
 void warn(java.lang.String key, java.lang.Object val)
           
 void warn(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2)
           
 void warn(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3)
           
 void warn(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4)
           
 void warn(java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4, java.lang.String k5, java.lang.Object v5)
           
 void warn(java.lang.String msg, java.lang.String key, java.lang.Object val)
           
 void warn(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2)
           
 void warn(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3)
           
 void warn(java.lang.String msg, java.lang.String key, java.lang.Object val, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4)
           
 void warn(java.lang.String msg, java.lang.Throwable e)
           
 void warn(java.lang.Throwable e)
           
 void warn(ToString msg)
           
 void warn(ToString msg, java.lang.Throwable e)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEBUG

public static final java.lang.String DEBUG
See Also:
Constant Field Values

INFO

public static final java.lang.String INFO
See Also:
Constant Field Values

WARN

public static final java.lang.String WARN
See Also:
Constant Field Values

ERROR

public static final java.lang.String ERROR
See Also:
Constant Field Values
Constructor Detail

StdLogger

public StdLogger()

StdLogger

public StdLogger(java.lang.String uid)
Constructs a new instance for which all output will include the provided uid. A typical use of the uid is to characterise a unique client request in some application or library.

Parameters:
uid -

StdLogger

public StdLogger(java.lang.String uid,
                 boolean printDate)
Constructs a new instance for which all output will include the provided uid and the date/time of the logging call. A typical use of the uid is to characterise a unique client request in some application or library.


StdLogger

public StdLogger(java.lang.String uid,
                 java.lang.String where)
Constructs a new instance for which all output will include the provided uid and a description of where the logging call is made.

A typical use of the uid is to characterise a unique client request in some application or library. If where is null, then the position of the logging call will be determined on-the-fly by inspecting the stack. If where is the empty string, the no information will be provided regarding the calling site.


StdLogger

public StdLogger(java.lang.String uid,
                 java.lang.String where,
                 boolean printDate)
Method Detail

forSite

public StdLogger forSite(java.lang.String where)
Constructs a new instance for with the description given by where will be appended the the information of the calling site.

This is useful when we have logger in some method A, which calls another method B, and we want the logs printed from method B to include the information that it has come from method A.

If in method A we have a logger:

 StdLogger logA = new StdLogger();
 
and a log from A is of the form:
 2007/10/21 13:22:55 [SomeClass.A] hello world!
 
then if a new logger is created and passed to B:
 StdLogger logB = logA.forSite("B");
 B(logB, ....)
 
the output in B will look like:
 2007/10/21 13:22:55 [SomeClass.A.B] hello world!
 
Notice the call site descriptions provided in the brackets, [SomeClass.A] and [SomeClass.A.B].

In the future, this info will be provided dynamically from the call stack.

Parameters:
where -

indent

public StdLogger indent()

unindent

public StdLogger unindent()

log

public void log(java.lang.String msg)

log

public void log(boolean b)

log

public void log(java.lang.String key,
                java.lang.Object val)

log

public void log(java.lang.String msg,
                java.lang.String key,
                java.lang.Object val)

log

public void log(java.lang.String key,
                java.lang.Object val,
                java.lang.String k2,
                java.lang.Object v2)

log

public void log(java.lang.String msg,
                java.lang.String key,
                java.lang.Object val,
                java.lang.String k2,
                java.lang.Object v2)

log

public void log(java.lang.String key,
                java.lang.Object val,
                java.lang.String k2,
                java.lang.Object v2,
                java.lang.String k3,
                java.lang.Object v3)

log

public void log(java.lang.String msg,
                java.lang.String key,
                java.lang.Object val,
                java.lang.String k2,
                java.lang.Object v2,
                java.lang.String k3,
                java.lang.Object v3)

log

public void log(java.lang.String key,
                java.lang.Object val,
                java.lang.String k2,
                java.lang.Object v2,
                java.lang.String k3,
                java.lang.Object v3,
                java.lang.String k4,
                java.lang.Object v4)

log

public void log(java.lang.String msg,
                java.lang.String key,
                java.lang.Object val,
                java.lang.String k2,
                java.lang.Object v2,
                java.lang.String k3,
                java.lang.Object v3,
                java.lang.String k4,
                java.lang.Object v4)

log

public void log(java.lang.String key,
                java.lang.Object val,
                java.lang.String k2,
                java.lang.Object v2,
                java.lang.String k3,
                java.lang.Object v3,
                java.lang.String k4,
                java.lang.Object v4,
                java.lang.String k5,
                java.lang.Object v5)

log

public void log(java.lang.String msg,
                java.lang.String key,
                java.lang.Object val,
                java.lang.String k2,
                java.lang.Object v2,
                java.lang.String k3,
                java.lang.Object v3,
                java.lang.String k4,
                java.lang.Object v4,
                java.lang.String k5,
                java.lang.Object v5)

log

public void log(ToString msg)

log

public void log(java.lang.Throwable msg)

log

public void log(java.lang.Object msg)

debug

public void debug(java.lang.String msg)

debug

public void debug(ToString msg)

debug

public void debug(java.lang.Throwable e)

debug

public void debug(java.lang.String msg,
                  java.lang.Throwable e)

debug

public void debug(ToString msg,
                  java.lang.Throwable e)

debug

public void debug(java.lang.Object o,
                  java.lang.Throwable e)

debug

public void debug(java.lang.Object msg)

debug

public void debug(java.lang.String key,
                  java.lang.Object val)

debug

public void debug(java.lang.String msg,
                  java.lang.String key,
                  java.lang.Object val)

debug

public void debug(java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2)

debug

public void debug(java.lang.String msg,
                  java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2)

debug

public void debug(java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2,
                  java.lang.String k3,
                  java.lang.Object v3)

debug

public void debug(java.lang.String msg,
                  java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2,
                  java.lang.String k3,
                  java.lang.Object v3)

debug

public void debug(java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2,
                  java.lang.String k3,
                  java.lang.Object v3,
                  java.lang.String k4,
                  java.lang.Object v4)

debug

public void debug(java.lang.String msg,
                  java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2,
                  java.lang.String k3,
                  java.lang.Object v3,
                  java.lang.String k4,
                  java.lang.Object v4)

debug

public void debug(java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2,
                  java.lang.String k3,
                  java.lang.Object v3,
                  java.lang.String k4,
                  java.lang.Object v4,
                  java.lang.String k5,
                  java.lang.Object v5)

info

public void info(ToString msg)

info

public void info(java.lang.Throwable e)

info

public void info(java.lang.String msg,
                 java.lang.Throwable e)

info

public void info(ToString msg,
                 java.lang.Throwable e)

info

public void info(java.lang.Object o,
                 java.lang.Throwable e)

info

public void info(java.lang.Object msg)

info

public void info(java.lang.String key,
                 java.lang.Object val)

info

public void info(java.lang.String msg,
                 java.lang.String key,
                 java.lang.Object val)

info

public void info(java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2)

info

public void info(java.lang.String msg,
                 java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2)

info

public void info(java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2,
                 java.lang.String k3,
                 java.lang.Object v3)

info

public void info(java.lang.String msg,
                 java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2,
                 java.lang.String k3,
                 java.lang.Object v3)

info

public void info(java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2,
                 java.lang.String k3,
                 java.lang.Object v3,
                 java.lang.String k4,
                 java.lang.Object v4)

info

public void info(java.lang.String msg,
                 java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2,
                 java.lang.String k3,
                 java.lang.Object v3,
                 java.lang.String k4,
                 java.lang.Object v4)

info

public void info(java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2,
                 java.lang.String k3,
                 java.lang.Object v3,
                 java.lang.String k4,
                 java.lang.Object v4,
                 java.lang.String k5,
                 java.lang.Object v5)

warn

public void warn(java.lang.String msg)

warn

public void warn(ToString msg)

warn

public void warn(java.lang.Throwable e)

warn

public void warn(java.lang.String msg,
                 java.lang.Throwable e)

warn

public void warn(ToString msg,
                 java.lang.Throwable e)

warn

public void warn(java.lang.Object o,
                 java.lang.Throwable e)

warn

public void warn(java.lang.Object msg)

warn

public void warn(java.lang.String key,
                 java.lang.Object val)

warn

public void warn(java.lang.String msg,
                 java.lang.String key,
                 java.lang.Object val)

warn

public void warn(java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2)

warn

public void warn(java.lang.String msg,
                 java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2)

warn

public void warn(java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2,
                 java.lang.String k3,
                 java.lang.Object v3)

warn

public void warn(java.lang.String msg,
                 java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2,
                 java.lang.String k3,
                 java.lang.Object v3)

warn

public void warn(java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2,
                 java.lang.String k3,
                 java.lang.Object v3,
                 java.lang.String k4,
                 java.lang.Object v4)

warn

public void warn(java.lang.String msg,
                 java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2,
                 java.lang.String k3,
                 java.lang.Object v3,
                 java.lang.String k4,
                 java.lang.Object v4)

warn

public void warn(java.lang.String key,
                 java.lang.Object val,
                 java.lang.String k2,
                 java.lang.Object v2,
                 java.lang.String k3,
                 java.lang.Object v3,
                 java.lang.String k4,
                 java.lang.Object v4,
                 java.lang.String k5,
                 java.lang.Object v5)

error

public void error(java.lang.String msg)

error

public void error(ToString msg)

error

public void error(java.lang.Throwable e)

error

public void error(java.lang.String msg,
                  java.lang.Throwable e)

error

public void error(ToString msg,
                  java.lang.Throwable e)

error

public void error(java.lang.Object o,
                  java.lang.Throwable e)

error

public void error(java.lang.Object msg)

error

public void error(java.lang.String key,
                  java.lang.Object val)

error

public void error(java.lang.String msg,
                  java.lang.String key,
                  java.lang.Object val)

error

public void error(java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2)

error

public void error(java.lang.String msg,
                  java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2)

error

public void error(java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2,
                  java.lang.String k3,
                  java.lang.Object v3)

error

public void error(java.lang.String msg,
                  java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2,
                  java.lang.String k3,
                  java.lang.Object v3)

error

public void error(java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2,
                  java.lang.String k3,
                  java.lang.Object v3,
                  java.lang.String k4,
                  java.lang.Object v4)

error

public void error(java.lang.String msg,
                  java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2,
                  java.lang.String k3,
                  java.lang.Object v3,
                  java.lang.String k4,
                  java.lang.Object v4)

error

public void error(java.lang.String key,
                  java.lang.Object val,
                  java.lang.String k2,
                  java.lang.Object v2,
                  java.lang.String k3,
                  java.lang.Object v3,
                  java.lang.String k4,
                  java.lang.Object v4,
                  java.lang.String k5,
                  java.lang.Object v5)

setUID

public void setUID(java.lang.String uid)

setWhere

public void setWhere(java.lang.String where)

getWhere

public java.lang.String getWhere()

getUID

public java.lang.String getUID()

enter

public void enter()

exit

public void exit()


Copyright © 1999-2007 Christos KK Loverdos. All Rights Reserved.