org.edg.data.util
Class MethodLogger

java.lang.Object
  |
  +--org.edg.data.util.MethodLogger

public class MethodLogger
extends java.lang.Object

A simple class which provides logging methods which are useful for logging API calls, with arguments and result codes. We split it into two categories, calls which change the state of something (Mutable) and calls which don't change the state. This allows you to easily filter out the calls you need to rerun to create the current db state. Currently, we don't provide the ability to record the previous state in mutable calls.

Version:
$ Id:$
Author:
James Casey

Constructor Summary
MethodLogger(java.lang.String logName)
          Construct a new MethodLogger, with the give log name
 
Method Summary
 boolean equals(java.lang.Object o)
           
 int hashCode()
           
 boolean isLoggingEnabled()
          Is logging of methods enabled ?
 boolean isMutableLoggingEnabled()
          Is logging of mutable methods enabled ?
 void log(java.lang.String name)
           
 void log(java.lang.String name, java.lang.String args)
           
 void logMutable(java.lang.String name)
           
 void logMutable(java.lang.String name, java.lang.String args)
           
 void logMutableWithResult(java.lang.String name, java.lang.String args, boolean result)
           
 void logMutableWithResult(java.lang.String name, java.lang.String args, java.lang.String result)
           
 void logWithResult(java.lang.String name, java.lang.String result)
           
 void logWithResult(java.lang.String name, java.lang.String[] result)
           
 void logWithResult(java.lang.String name, java.lang.String args, boolean result)
           
 void logWithResult(java.lang.String name, java.lang.String args, java.lang.String result)
           
 void logWithResult(java.lang.String name, java.lang.String args, java.lang.String[] result)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MethodLogger

public MethodLogger(java.lang.String logName)
Construct a new MethodLogger, with the give log name

Parameters:
logName - the log name
Method Detail

logMutable

public void logMutable(java.lang.String name)

logMutable

public void logMutable(java.lang.String name,
                       java.lang.String args)

logMutableWithResult

public void logMutableWithResult(java.lang.String name,
                                 java.lang.String args,
                                 java.lang.String result)

logMutableWithResult

public void logMutableWithResult(java.lang.String name,
                                 java.lang.String args,
                                 boolean result)

log

public void log(java.lang.String name)

log

public void log(java.lang.String name,
                java.lang.String args)

logWithResult

public void logWithResult(java.lang.String name,
                          java.lang.String result)

logWithResult

public void logWithResult(java.lang.String name,
                          java.lang.String[] result)

logWithResult

public void logWithResult(java.lang.String name,
                          java.lang.String args,
                          boolean result)

logWithResult

public void logWithResult(java.lang.String name,
                          java.lang.String args,
                          java.lang.String result)

logWithResult

public void logWithResult(java.lang.String name,
                          java.lang.String args,
                          java.lang.String[] result)

isLoggingEnabled

public boolean isLoggingEnabled()
Is logging of methods enabled ?

Returns:
true if it is.

isMutableLoggingEnabled

public boolean isMutableLoggingEnabled()
Is logging of mutable methods enabled ?

Returns:
true if it is.

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object