Module is.codion.common.core

Package is.codion.common.logging

Interface MethodLogger

public interface MethodLogger

A method call logger allowing logging of nested method calls.

See Also:

• methodLogger(int)
• methodLogger(int, ArgumentToString)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MethodLogger.ArgumentToString	Provides String representations of method arguments for log display.
static class	MethodLogger.DefaultArgumentToString	Provides String representations of method arguments.
static interface	MethodLogger.Entry	A method logger entry.

Method Summary

Modifier and Type	Method	Description
void	enter(String method)
void	enter(String method, Object argument)
List<MethodLogger.Entry>	entries()
MethodLogger.Entry	exit(String method)
MethodLogger.Entry	exit(String method, Throwable exception)
MethodLogger.Entry	exit(String method, Throwable exception, String exitMessage)
boolean	isEnabled()
static MethodLogger	methodLogger(int maxSize)	Creates a new MethodLogger, disabled by default.
static MethodLogger	methodLogger(int maxSize, MethodLogger.ArgumentToString argumentStringProvider)	Creates a new MethodLogger, disabled by default.
void	setEnabled(boolean enabled)

Method Details

enter

void enter(String method)

Parameters:

method - the method being entered

enter

void enter(String method,
 Object argument)

Parameters:

method - the method being entered

argument - the method argument, can be an Object, a collection or an array

exit

MethodLogger.Entry exit(String method)

Parameters:

method - the method being exited

Returns:

the Entry

exit

MethodLogger.Entry exit(String method,
 Throwable exception)

Parameters:

method - the method being exited

exception - the exception, if any

Returns:

the Entry

exit

MethodLogger.Entry exit(String method,
 Throwable exception,
 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

boolean isEnabled()

Returns:

true if this logger is enabled

setEnabled

void setEnabled(boolean enabled)

Parameters:

enabled - true to enable this logger

entries

List<MethodLogger.Entry> entries()

Returns:

an unmodifiable view of the log entries

methodLogger

static MethodLogger methodLogger(int maxSize)

Creates a new MethodLogger, disabled by default.

Parameters:

maxSize - the maximum log size

Returns:

a new MethodLogger instance

methodLogger

static MethodLogger methodLogger(int maxSize,
 MethodLogger.ArgumentToString argumentStringProvider)

Creates a new MethodLogger, disabled by default.

Parameters:

maxSize - the maximum log size

argumentStringProvider - responsible for providing String representations of method arguments

Returns:

a new MethodLogger instance