oracle.javatools.util

Class LoggingInvocationHandler<T>

java.lang.Object

oracle.javatools.util.LoggingInvocationHandler<T>

Type Parameters:

T - the type of class to be instrumented

All Implemented Interfaces:

java.lang.reflect.InvocationHandler

public class LoggingInvocationHandler<T>
extends java.lang.Object
implements java.lang.reflect.InvocationHandler

The LoggingInvocationHandler class is useful for instrumenting a class to log all method invocations with the accompanying arguments and return value.

Constructor Summary

Constructors

Constructor and Description
LoggingInvocationHandler(java.lang.reflect.InvocationHandler decorated, java.util.logging.Logger logger) Create a new LoggingInvocationHandler for the given InvocationHandler (to be decorated) and logger.
LoggingInvocationHandler(T delegate, java.util.logging.Logger logger) Create a new LoggingInvocationHandler for the given delegate and logger.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.logging.Level	getLevel()
java.lang.Object	invoke(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args)
void	setIncludeStackTrace(boolean includeStack) Set whether or not log statements should include the stack trace (default is false).
void	setLevel(java.util.logging.Level logLevel) Set the Level at which the log statements will be logged.
void	setMethodFilter(Filter<java.lang.reflect.Method> filter) Use the given filter to determine which methods should be logged.
void	setMethodNames(java.lang.String... methodNames) Set the name(s) of the method(s) which should be logged.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingInvocationHandler

public LoggingInvocationHandler(T delegate,
                        java.util.logging.Logger logger)

Create a new LoggingInvocationHandler for the given delegate and logger.

Parameters:

delegate - the delegate to which all method invocations will be forwarded

logger - the logger to which all log statements will be sent

LoggingInvocationHandler

public LoggingInvocationHandler(java.lang.reflect.InvocationHandler decorated,
                        java.util.logging.Logger logger)

Create a new LoggingInvocationHandler for the given InvocationHandler (to be decorated) and logger.

Parameters:

decorated - another InvocationHandler to which all method invocations will be forwarded

logger - the Logger to which all log statements will be forwarded

Throws:

java.lang.IllegalArgumentException - if either argument is null

Method Detail

invoke

public final java.lang.Object invoke(java.lang.Object proxy,
                      java.lang.reflect.Method method,
                      java.lang.Object[] args)
                              throws java.lang.Throwable

Specified by:

invoke in interface java.lang.reflect.InvocationHandler

Throws:

java.lang.Throwable

setLevel

public void setLevel(java.util.logging.Level logLevel)

Set the Level at which the log statements will be logged.

Parameters:

logLevel -

getLevel

public java.util.logging.Level getLevel()

Returns:

the current logging level

setIncludeStackTrace

public void setIncludeStackTrace(boolean includeStack)

Set whether or not log statements should include the stack trace (default is false).

Parameters:

includeStack - true if log statements should include the stack trace, false (default) otherwise

setMethodFilter

public void setMethodFilter(Filter<java.lang.reflect.Method> filter)

Use the given filter to determine which methods should be logged.

Parameters:

filter -

setMethodNames

public void setMethodNames(java.lang.String... methodNames)

Set the name(s) of the method(s) which should be logged. The name should be in regular expression format.

Parameters:

methodNames -