org.jminor.common

Class MethodLogger

java.lang.Object

org.jminor.common.MethodLogger

public final class MethodLogger
extends java.lang.Object

A method call logger allowing logging of nested method calls. TODO this class should be able to handle/recover from incorrect usage, not crash the application

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MethodLogger.ArgumentStringProvider Provides String representations of method arguments
static class	MethodLogger.DefaultArgumentStringProvider A default MethodLogger.ArgumentStringProvider implementation based on String.valueOf(Object)
static class	MethodLogger.Entry A log entry

Constructor Summary

Constructors

Constructor and Description
MethodLogger(int maxSize, boolean enabled) Instantiates a new MethodLogger.
MethodLogger(int maxSize, boolean enabled, MethodLogger.ArgumentStringProvider argumentStringProvider) Instantiates a new MethodLogger.

Method Summary

Modifier and Type	Method and Description
static void	appendLogEntries(java.lang.StringBuilder log, java.util.List<MethodLogger.Entry> entries, int indentationLevel) Appends the given log entries to the log
static void	appendLogEntry(java.lang.StringBuilder log, MethodLogger.Entry entry, int indentationLevel) Appends the given log entries to the log
java.util.List<MethodLogger.Entry>	getEntries()
boolean	isEnabled()
void	logAccess(java.lang.String method)
void	logAccess(java.lang.String method, java.lang.Object[] arguments)
MethodLogger.Entry	logExit(java.lang.String method)
MethodLogger.Entry	logExit(java.lang.String method, java.lang.Throwable exception)
MethodLogger.Entry	logExit(java.lang.String method, java.lang.Throwable exception, java.lang.String exitMessage)
void	setEnabled(boolean enabled)

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodLogger

public MethodLogger(int maxSize,
                    boolean enabled)

Instantiates a new MethodLogger.

Parameters:

maxSize - the maximum log size

enabled - true if this logger should be enabled

MethodLogger

public MethodLogger(int maxSize,
                    boolean enabled,
                    MethodLogger.ArgumentStringProvider argumentStringProvider)

Instantiates a new MethodLogger.

Parameters:

maxSize - the maximum log size

enabled - true if this logger should be enabled

argumentStringProvider - the ArgumentStringProvider

Method Detail

logAccess

public void logAccess(java.lang.String method)

Parameters:

method - the method being accessed

logAccess

public void logAccess(java.lang.String method,
                      java.lang.Object[] arguments)

Parameters:

method - the method being accessed

arguments - the method arguments

logExit

public MethodLogger.Entry logExit(java.lang.String method)

Parameters:

method - the method being exited

Returns:

the Entry

logExit

public MethodLogger.Entry logExit(java.lang.String method,
                                  java.lang.Throwable exception)

Parameters:

method - the method being exited

exception - the exception, if any

Returns:

the Entry

logExit

public MethodLogger.Entry logExit(java.lang.String method,
                                  java.lang.Throwable exception,
                                  java.lang.String exitMessage)

Parameters:

method - the method being exited

exception - the exception, if any

exitMessage - the message to associate with exiting the method

Returns:

the Entry, or null if this logger is not enabled

isEnabled

public boolean isEnabled()

Returns:

true if this logger is enabled

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - true to enable this logger

getEntries

public java.util.List<MethodLogger.Entry> getEntries()

Returns:

an unmodifiable view of the log entries

appendLogEntry

public static void appendLogEntry(java.lang.StringBuilder log,
                                  MethodLogger.Entry entry,
                                  int indentationLevel)

Appends the given log entries to the log

Parameters:

log - the log

entry - the log entry to append

indentationLevel - the indentation to use for the given log entries

appendLogEntries

public static void appendLogEntries(java.lang.StringBuilder log,
                                    java.util.List<MethodLogger.Entry> entries,
                                    int indentationLevel)

Appends the given log entries to the log

Parameters:

log - the log

entries - the List containing the entries to append

indentationLevel - the indentation to use for the given log entries