org.cojen.dirmi.trace

Interface TraceHandler

All Known Implementing Classes:

NullHandler, ScopedTraceHandler, SimpleHandler

public interface TraceHandler

A trace handler is responsible for gathering and processing traced method invocations. Implementations must have a public constructor which accepts a TraceToolbox instance, and it may also accept a String argument.

 public class MyHandler implements TraceHandler {
     public MyHandler(TraceToolbox toolbox, String arg) {
         ...
     }

     ...
 }
 

Author:

Brian S O'Neill

See Also:

Trace, TraceAgent

Method Summary

Modifier and Type	Method and Description
void	enterMethod(int mid) Called by a traced method upon entry.
void	enterMethod(int mid, Object... arguments) Called by a traced method upon entry.
void	enterMethod(int mid, Object argument) Called by a traced method upon entry.
void	exitMethod(int mid) Called by a traced method upon exit.
void	exitMethod(int mid, long timeNanos) Called by a traced method upon exit.
void	exitMethod(int mid, Object result) Called by a traced method upon exit.
void	exitMethod(int mid, Object result, long timeNanos) Called by a traced method upon exit.
void	exitMethod(int mid, Throwable t) Called by a traced method upon exit caused by a thrown exception.
void	exitMethod(int mid, Throwable t, long timeNanos) Called by a traced method upon exit caused by a thrown exception.
TraceModes	getTraceModes(String className) Return allowed tracing modes for the given class.

Method Detail

getTraceModes

TraceModes getTraceModes(String className)

Return allowed tracing modes for the given class.

Parameters:

className - full name of class which may contain traced methods

Returns:

modes or null if none allowed

enterMethod

void enterMethod(int mid)

Called by a traced method upon entry.

Parameters:

mid - method id

enterMethod

void enterMethod(int mid,
                 Object argument)

Called by a traced method upon entry. This method is never called if the trace was not configured to pass arguments or if the traced method has no arguments.

Parameters:

mid - method id

argument - argument passed to method; is "this" for non-static method

enterMethod

void enterMethod(int mid,
                 Object... arguments)

Called by a traced method upon entry. This method is never called if the trace was not configured to pass arguments or if the traced method has no arguments.

Parameters:

mid - method id

arguments - arguments passed to method; first is "this" for non-static method

exitMethod

void exitMethod(int mid)

Called by a traced method upon exit.

Parameters:

mid - method id

exitMethod

void exitMethod(int mid,
                long timeNanos)

Called by a traced method upon exit. This method is never called if the trace was not configured to measure execution time.

Parameters:

mid - method id

timeNanos - total execution time of method, in nanoseconds

exitMethod

void exitMethod(int mid,
                Object result)

Called by a traced method upon exit. This method is never called if the trace was not configured to pass return values or if the traced method returns void.

Parameters:

mid - method id

result - method return value

exitMethod

void exitMethod(int mid,
                Object result,
                long timeNanos)

Called by a traced method upon exit. This method is never called if the trace was not configured to pass return values and measure execution time.

Parameters:

mid - method id

result - method return value

timeNanos - total execution time of method, in nanoseconds

exitMethod

void exitMethod(int mid,
                Throwable t)

Called by a traced method upon exit caused by a thrown exception. This method is never called if the trace was not configured to pass thrown exceptions.

Parameters:

mid - method id

t - exception thrown by method

exitMethod

void exitMethod(int mid,
                Throwable t,
                long timeNanos)

Called by a traced method upon exit caused by a thrown exception. This method is never called if the trace was not configured to pass thrown exceptions and measure execution time.

Parameters:

mid - method id

t - exception thrown by method

timeNanos - total execution time of method, in nanoseconds